ファイルの分類を更新

put
https://api.box.com/2.0
/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo/

ファイルの分類を更新します。

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

Request

Bearer [ACCESS_TOKEN]
application/json-patch+json

Path Parameters

stringin pathrequired
12345

ファイルを表す一意の識別子。

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

Request Body

object arrayin bodyrequired

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

stringin bodyoptional
replace

Value is always replace

stringin bodyoptional
/Box__Security__Classification__Key

Value is always /Box__Security__Classification__Key

stringin bodyoptional
Sensitive

このファイルに適用する分類の名前。

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

Response

application/json分類

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

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

  • bad_request - リクエスト本文の形式が有効なJSON Patch操作の配列ではありません。

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

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

put
ファイルの分類を更新
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X PUT "https://api.box.com/2.0/files/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"
     }]'
Java
BoxFile file = new BoxFile(api, "id");
Metadata metadata = new Metadata()
metadata.add(Metadata.CLASSIFICATION_KEY, "Sensitive")
file.setMetadata(Metadata.CLASSIFICATION_TEMPLATE_KEY, Metadata.ENTERPRISE_METADATA_SCOPE, metadata);
Python
classification = {
    'Box__Security__Classification__Key': 'Sensitive',
}
applied_metadata = client.file(file_id='11111').metadata(scope='enterprise', template='securityClassification-6VMVochwUWo').set(classification)
Node
var classification = {
	Box__Security__Classification__Key: "Sensitive"
};
client.files.addMetadata('11111', 'enterprise', 'securityClassification-6VMVochwUWo', classification)
	.then(metadata => {
		// the updated classification applied to the file
	});

Response Example

{
  "$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"
}