Box Developerドキュメント

分類を追加

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

会社が使用できる分類のリストに1つ以上の新しい分類を追加します。

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

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエスト本文

object array本文内必須

会社の分類のリストに追加する1つ以上の分類を含む配列。

object本文内

追加する分類の詳細。

string本文内必須
"Sensitive"

ウェブインターフェースおよびモバイルインターフェースに表示される分類のラベル。これは、分類を追加するために必要な唯一のフィールドです。

object本文内

分類の静的な構成。

分類の追加情報。

string本文内必須
"Box__Security__Classification__Key"

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

次の値に固定: Box__Security__Classification__Key

string本文内必須
"addEnumOption"

分類オブジェクトに対して実行する変更の種類。

次の値に固定: addEnumOption

レスポンス

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

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

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

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

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

リクエストの例

cURL
curl -i -X PUT "https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json-patch+json" \
     -d '[{
       "op": "addEnumOption",
       "fieldKey": "Box__Security__Classification__Key",
       "data": {
         "key": "Sensitive",
         "staticConfig":{
          "classification": {
            "classificationDefinition": "Sensitive information that must not be shared.",
            "colorID": 4
            }
         }
       }
     }]'
Java
List<MetadataTemplate.FieldOperation> updates = new ArrayList<MetadataTemplate.FieldOperation>();

String update = "{\n  op: \"addEnumOption\",\n  fieldKey: \"Box__Security__Classification__Key\",\n  data: {\n    key: \"Sensitive\"\n }\n}";

updates.add(new MetadataTemplate.FieldOperation(addCategoryFieldJSON));

MetadataTemplate.updateMetadataTemplate(api, Metadata.ENTERPRISE_METADATA_SCOPE, Metadata.CLASSIFICATION_TEMPLATE_KEY, updates);
Python
template = client.metadata_template('enterprise', 'securityClassification-6VMVochwUWo')
new_updates = template.start_update()
new_updates.add_enum_option('Box__Security__Classification__Key', 'Sensitive')
updated_template = template.update_info(updates=new_updates)
.NET
var update = new BoxMetadataTemplateUpdate
{
    Op = MetadataTemplateUpdateOp.addEnumOption,
    FieldKey = "Box_Security_Classification_Key",
    Data = new
    {
        key = "Sensitive"
    }
};

var template = await client.MetadataManager
    .UpdateMetadataTemplate(new List<BoxMetadataTemplateUpdate>() { update }, "enterprise", "securityClassification-6VMVochwUWo");
Node
var operations = [{
  op: "addEnumOption",
  fieldKey: "Box__Security__Classification__Key",
  data: {
    key: "Sensitive",
    classification: {
      classificationDefinition: "Sensitive information that must not be shared.",
      colorID: 4
    }
 }
}];
client.metadata.updateTemplate('enterprise', 'securityClassification-6VMVochwUWo', operations)
	.then(template => {
		// the updated 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"
}