Box Developerドキュメント

すべての分類のリストを取得

get
https://api.box.com/2.0
/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema

分類メタデータテンプレートを取得し、この会社が使用できるすべての分類のリストを取得します。

このAPIは、/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schemaのように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。

レスポンス

securityClassificationメタデータテンプレートを返します。これには、この会社が使用できるすべての分類のリストを取得するBox__Security__Classification__Keyフィールドが含まれています。

リクエストパラメータのいずれかが無効な場合に返されます。

テンプレート名が正しくないときに返されます。リクエストのURLが正しいことを確認してください。

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

get
すべての分類のリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.classifications.getClassificationTemplate();
Python Gen
client.classifications.get_classification_template()
.NET Gen
await client.Classifications.GetClassificationTemplateAsync();
Java
MetadataTemplate template = MetadataTemplate.getMetadataTemplate(api, Metadata.CLASSIFICATION_TEMPLATE_KEY);
Python
template = client.metadata_template('enterprise', 'securityClassification-6VMVochwUWo').get()
.NET
var template = await client.MetadataManager.GetMetadataTemplate("enterprise", "securityClassification-6VMVochwUWo");
Node
client.metadata.getTemplateSchema('enterprise', 'securityClassification-6VMVochwUWo')
	.then(template => {
		// the classification template
	});

レスポンスの例

{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "copyInstanceOnItemCopy": true,
  "displayName": "Classification",
  "fields": [
    {
      "id": "822227e0-47a5-921b-88a8-494760b2e6d2",
      "type": "enum",
      "key": "Box__Security__Classification__Key",
      "displayName": "Classification",
      "hidden": false,
      "options": [
        {
          "id": "46aea176-3483-4431-856c-6b5b13d1cc50",
          "key": "Sensitive",
          "staticConfig": {
            "classification": {
              "classificationDefinition": "Sensitive information",
              "colorID": 4
            }
          }
        }
      ]
    }
  ],
  "hidden": false,
  "scope": "enterprise_123456",
  "templateKey": "securityClassification-6VMVochwUWo"
}