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

最初の分類を追加

post
https://api.box.com/2.0
/metadata_templates/schema

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

会社にまだ分類がない場合は、このAPIコールによって、分類テンプレートが最初の一連の分類で初期化されます。

会社にすでに分類がある場合は、テンプレートがすでに存在するため、さらに分類を追加するためにAPIコールが行われます。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

boolean本文内省略可能
false

ファイルまたはフォルダをコピーするときに分類もコピーするかどうかを決定します。

string本文内必須
"Classification"

ウェブインターフェースおよびモバイルインターフェースに表示されるテンプレートの名前。

次の値に固定: Classification

object array本文内必須

分類テンプレートにはフィールドが1つだけ必要で、このフィールドでは、有効な分類の値がすべて保持されます。

string本文内必須
"enum"

常に列挙型となるフィールドのタイプ。

次の値に固定: enum

string本文内必須
"Classification"

分類の表示名。

次の値に固定: Classification

boolean本文内省略可能
false

分類テンプレートをウェブおよびモバイルデバイスで非表示にするか使用可能にするかを決定します。

string本文内必須
"Box__Security__Classification__Key"

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

次の値に固定: Box__Security__Classification__Key

object array本文内必須

このテンプレートに存在する実際の分類のリスト。

string本文内必須
"Sensitive"

この分類の表示名とキー。これはBox UIに表示されます。

object本文内

分類に関する追加情報。

object本文内

分類に関する追加情報。

boolean本文内省略可能
false

分類テンプレートをウェブおよびモバイルデバイスで非表示にするか使用可能にするかを決定します。

string本文内必須
"enterprise"

分類を作成するスコープ。これには、enterpriseまたはenterprise_{id} (idは会社の一意のID) を指定する必要があります。

次の値に固定: enterprise

string本文内必須
"securityClassification-6VMVochwUWo"

メタデータテンプレートのリストを定義します。

次の値に固定: securityClassification-6VMVochwUWo

レスポンス

application/json分類テンプレート

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

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

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

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

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

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

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

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

リクエストの例

cURL
curl -i -X POST "https://api.box.com/2.0/metadata_templates/schema" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "templateKey": "securityClassification-6VMVochwUWo",
       "scope": "enterprise",
       "displayName": "Classification",
       "hidden": false,
       "copyInstanceOnItemCopy": true,
       "fields": [
         {
           "type": "enum",
           "key": "Box__Security__Classification__Key",
           "displayName": "Classification",
           "hidden": false,
           "options": [
             {
               "key": "Classified",
               "staticConfig": {
                 "classification": {
                   "colorID": 7,
                   "classificationDefinition": "Top Seret"
                 }
               }
             }
           ]
         }
       ]
     }'
Java
MetadataTemplate.Field classification = new MetadataTemplate.Field();
classification.setType("enum");
classification.setKey(Metadata.CLASSIFICATION_KEY);
classification.setDisplayName("Classification");
classification.setHidden("false");

List<String> options = new ArrayList<String>();
options.add("Top Secret");
classification.setOptions(topSecret)

List<MetadataTemplate.Field> fields = new ArrayList<MetadataTemplate.Field>();
fields.add(classification);

MetadataTemplate template = MetadataTemplate.createMetadataTemplate(api, Metadata.ENTERPRISE_METADATA_SCOPE, Metadata.CLASSIFICATION_TEMPLATE_KEY, "Classification", false, fields);
Python
from boxsdk.object.metadata_template import MetadataField, MetadataFieldType

fields = [
    MetadataField(MetadataFieldType.ENUM, 'Classification', key='Box__Security__Classification__Key', options=['Top Secret'])
]

template = client.create_metadata_template('Classification', fields, template_key='securityClassification-6VMVochwUWo')
.NET
var field = new BoxMetadataTemplateField
{
    DisplayName = "Classification",
    Type = "enum",
    Key = "Box_Security_Classification_Key",
    Options = new List<BoxMetadataTemplateFieldOption>() 
    {
        new BoxMetadataTemplateFieldOption
        {
            Key = "Classified"
        }
    }
};

var metadataTemplate = new BoxMetadataTemplate
{
    DisplayName = "Classification",
    TemplateKey = "securityClassification-6VMVochwUWo",
    Scope = "enterprise",
    Fields = new List<BoxMetadataTemplateField>() { field },
};

var template = await client.MetadataManager.CreateMetadataTemplate(metadataTemplate);
Node
client.metadata.createTemplate(
		'Classification',
		[
      {
        type: "enum",
        key: "Box__Security__Classification__Key",
        displayName: "Classification",
        hidden: false,
        options: [
         {
           key: "Classified",
           staticConfig: {
             classification: {
               colorID: 7,
               classificationDefinition: "Top Seret"
             }
           }
         }
       ]
      }
    ],
		{
			hidden: false,
			templateKey: 'securityClassification-6VMVochwUWo'
		}
	)
	.then(template => {
		// the new classification template
	});

レスポンスの例

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