Box Developerドキュメント
ログイン
最新バージョン

フォルダの分類を更新

put
https://api.box.com/2.0
/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

フォルダの分類を更新します。

分類を更新できるのは、分類がすでにフォルダに適用されている場合のみです。分類を編集する際は、会社に対して定義されている値のみを使用できます。

リクエスト

bearer [ACCESS_TOKEN]
application/json-patch+json

パスパラメータ

stringパス内必須
12345

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。

Boxアカウントのルートフォルダは常にID 0で表されます。

リクエスト本文

object array本文内必須

分類ラベルを更新するために加える1つの変更を含むリスト。

string本文内必須
"replace"

値は常にreplaceになります。

次の値に固定: replace

string本文内必須
"/Box__Security__Classification__Key"

企業で使用できる分類を定義します。

次の値に固定: /Box__Security__Classification__Key

string本文内必須
"Sensitive"

このフォルダに適用する分類の名前。

会社で使用できる分類のリストを取得するには、分類APIを使用して、使用可能なすべての分類キーが表示される分類テンプレートを取得します。

レスポンス

application/json分類

更新された分類メタデータテンプレートインスタンスを返します。

application/jsonクライアントエラー

リクエスト本文が無効な場合にエラーを返します。

  • bad_request - リクエスト本文の形式が有効なJSON Patch操作の配列ではありません。
application/jsonクライアントエラー

リクエスト本文が有効なJSON Patch項目の配列でない場合、一部のエッジケースでエラーを返します。

application/jsonクライアントエラー

予期しないクライアントエラー。

put
フォルダの分類を更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

sdk


cURL
curl -i -X PUT "https://api.box.com/2.0/folders/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json-patch+json" \
     -d '[{
       "op": "replace",
       "path": "/Box__Security__Classification__Key",
       "value": "Internal"
     }]'
TypeScript Gen
await client.folderClassifications.updateClassificationOnFolder(folder.id, [
  new UpdateClassificationOnFolderRequestBody({
    value: secondClassification.key,
  }),
]);
Python Gen
client.folder_classifications.update_classification_on_folder(
    folder.id,
    [UpdateClassificationOnFolderRequestBody(value=second_classification.key)],
)
.NET Gen
await client.FolderClassifications.UpdateClassificationOnFolderAsync(folderId: folder.Id, requestBody: Array.AsReadOnly(new [] {new UpdateClassificationOnFolderRequestBody(value: secondClassification.Key)}));
Swift Gen (Beta)
try await client.folderClassifications.updateClassificationOnFolder(folderId: folder.id, requestBody: [UpdateClassificationOnFolderRequestBody(value: secondClassification.key)])
Java Gen (Beta)
client.getFolderClassifications().updateClassificationOnFolder(folder.getId(), Arrays.asList(new UpdateClassificationOnFolderRequestBody(secondClassification.getKey())))
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 update = new BoxMetadataUpdate
{
    Op = MetadataUpdateOp.replace,
    Path = "/Box_Security_Classification_Key",
    Value = "Very Sensitive"
};

var classificationData = await client.MetadataManager
    .UpdateFolderMetadataAsync(folderId, new List<BoxMetadataUpdate>(){ update }, "enterprise", "securityClassification-6VMVochwUWo");
Node
var classification = {
	Box__Security__Classification__Key: "Sensitive"
};
client.folders.addMetadata('11111', 'enterprise', 'securityClassification-6VMVochwUWo', classification)
	.then(metadata => {
		// the updated 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"
}