フォルダに分類を追加
追加する分類のラベルを指定することで、フォルダに分類を追加します。
このAPIは、/folders/:id/enterprise_12345/securityClassification-6VMVochwUWoのように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
12345フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。
Boxアカウントのルートフォルダは常にID 0で表されます。
リクエスト本文
string本文内省略可能
"Sensitive"このフォルダに適用する分類の名前。
会社で使用できる分類のリストを取得するには、分類APIを使用して、使用可能なすべての分類キーが表示される分類テンプレートを取得します。
レスポンス
application/json分類
フォルダに適用された分類テンプレートインスタンスを返します。
application/jsonクライアントエラー
リクエスト本文が無 効な場合にエラーを返します。
schema_validation_failed- リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、enumまたはmultiSelectフィールドに不明なオプションが指定されている場合があります。
application/jsonクライアントエラー
フォルダテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。
not_found- フォルダが見つからないか、ユーザーがフォルダにアクセスできません。instance_tuple_not_found- メタデータテンプレートが見つかりませんでした。
application/jsonクライアントエラー
このメタデータテンプレートのインスタンスがすでにフォルダに存在する場合はエラーを返します。
tuple_already_exists- メタデータテンプレートのインスタンスがすでにフォルダに存在する場合に返されます。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X POST "https://api.box.com/2.0/folders/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"Box__Security__Classification__Key": "Sensitive"
}'TypeScript Gen
await client.folderClassifications.addClassificationToFolder(folder.id, {
requestBody: {
boxSecurityClassificationKey: classification.key,
} satisfies AddClassificationToFolderRequestBody,
} satisfies AddClassificationToFolderOptionalsInput);Python Gen
client.folder_classifications.add_classification_to_folder(
folder.id, box_security_classification_key=classification.key
).NET Gen
await client.FolderClassifications.AddClassificationToFolderAsync(folderId: folder.Id, requestBody: new AddClassificationToFolderRequestBody() { BoxSecurityClassificationKey = classification.Key });Java
BoxFolder folder = new BoxFolder(api, "id");
Metadata metadata = new Metadata()
metadata.add(Metadata.CLASSIFICATION_KEY, "Sensitive")
folder.setMetadata(Metadata.CLASSIFICATION_TEMPLATE_KEY, Metadata.ENTERPRISE_METADATA_SCOPE, metadata);Python
classification = {
'Box__Security__Classification__Key': 'Sensitive',
}
applied_metadata = client.folder(folder_id='11111').metadata(scope='enterprise', template='securityClassification-6VMVochwUWo').set(classification).NET
var folderId = "0";
var classification = new Dictionary<string, object>
{
{ "Box_Security_Classification_Key", "Sensitive" }
};
var classificationData = await client.MetadataManager.SetFolderMetadataAsync(folderId, classification, "enterprise", "securityClassification-6VMVochwUWo");Node
var classification = {
Box__Security__Classification__Key: "Sensitive"
};
client.folders.addMetadata('11111', 'enterprise', 'securityClassification-6VMVochwUWo', classification)
.then(metadata => {
// the classification applied to the folder
});レスポンスの例
{
"$canEdit": true,
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "securityClassification-6VMVochwUWo",
"$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
"$typeVersion": 5,
"$version": 1,
"Box__Security__Classification__Key": "Sensitive"
}