ファイルに分類を追加

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

追加する分類のラベルを指定することで、ファイルに分類を追加します。

このAPIは、/files/:id//enterprise_12345/securityClassification-6VMVochwUWoのように、URLにエンタープライズIDを明示的に含めることで呼び出すこともできます。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

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

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

リクエスト本文

string本文内省略可能
Sensitive

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

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

レスポンス

application/json分類

ファイルに適用された分類テンプレートインスタンスを返します。

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

  • schema_validation_failed - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、enumまたはmultiSelectフィールドに不明なオプションが指定されている場合があります。

ファイルテンプレートまたはメタデータテンプレートが見つからない場合はエラーを返します。

  • not_found - ファイルが見つからないか、ユーザーがファイルにアクセスできない場合に返されます。
  • instance_tuple_not_found - メタデータテンプレートが見つからない場合に返されます。

このメタデータテンプレートのインスタンスがすでにファイルに存在する場合はエラーを返します。

  • tuple_already_exists - メタデータテンプレートのインスタンスがすでにファイルに存在する場合に返されます。

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

post
ファイルに分類を追加
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/files/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
       "Box__Security__Classification__Key": "Sensitive"
     }'
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 classification applied to the file
	});

レスポンスの例

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