最新バージョン
ファイルの分類を取得
APIバージョン 2024.0
ファイルに適用されている分類メタデータインスタンスを取得します。
このAPIは、/files/:id//enterprise_12345/securityClassification-6VMVochwUWoのように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
12345ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。
レスポンス
application/json分類
securityClassificationメタデータテンプレートのインスタンスを返します。これには、この会社が使用できるすべての分類のリストを取得するBox__Security__Classification__Keyフィールドが含まれています。
application/jsonクライアントエラー
リクエストパラメータが無効な場合に返されます。
application/jsonクライアントエラー
指定したメタデータテンプレートがこのファイルに適用されていない場合、またはユーザーがこのファイルにアクセスできない場合に返されます。
instance_not_found- メタデータテンプレートがファイルに適用されていなかった場合に返されます。
application/jsonクライアントエラー
メソッドが許可されなかった場合に返されます。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.fileClassifications.getClassificationOnFile(file.id);Python Gen
client.file_classifications.get_classification_on_file(file.id).NET Gen
await client.FileClassifications.GetClassificationOnFileAsync(fileId: file.Id);Java
BoxFile file = new BoxFile(api, "id");
Metadata metadata = file.getMetadata(Metadata.CLASSIFICATION_TEMPLATE_KEY);Python
metadata = client.file(file_id='11111').metadata(scope='enterprise', template='securityClassification-6VMVochwUWo').get().NET
var fileId = "0";
var fileMetadata = await client.MetadataManager.GetFileMetadataAsync(fileId, "enterprise", "securityClassification-6VMVochwUWo");Node
client.files.getMetadata('11111', 'enterprise', 'securityClassification-6VMVochwUWo')
.then(metadata => {
// the metadata instance, which includes the applied metadata
});レスポンスの例
{
"$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"
}