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

curl --request GET \
  --url https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema \
  --header 'Authorization: Bearer <token>'

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

GET

metadata_templates

enterprise

securityClassification-6VMVochwUWo

schema

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

curl --request GET \
  --url https://api.box.com/2.0/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema \
  --header 'Authorization: Bearer <token>'

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

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

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

会社が定義したセキュリティ分類を保持するメタデータテンプレート。

string

required

分類テンプレートのID。

Example:

"58063d82-4128-7b43-bba9-92f706befcdf"

type

enum<string>

required

値は常にmetadata_templateになります。

利用可能なオプション:

metadata_template

Example:

"metadata_template"

scope

string

required

分類テンプレートのスコープ。これはenterprise_{id}形式 (idはEnterprise ID) になります。

Example:

"enterprise_123456"

templateKey

enum<string>

required

値は常にsecurityClassification-6VMVochwUWoになります。

利用可能なオプション:

securityClassification-6VMVochwUWo

Example:

"securityClassification-6VMVochwUWo"

displayName

enum<string>

required

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

利用可能なオプション:

Classification

Example:

"Classification"

fields

object[]

required

この分類テンプレートのフィールドのリスト。これには、Box__Security__Classification__Keyというフィールドが1つだけ含まれています。これにより、この会社で使用できるさまざまな分類が定義されます。

Required array length: 1 element

表示子属性

fields.id

string

required

フィールドの一意のID。

Example:

"822227e0-47a5-921b-88a8-494760b2e6d2"

fields.type

enum<string>

required

配列の項目のタイプ。

利用可能なオプション:

enum

Example:

"enum"

fields.key

enum<string>

required

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

利用可能なオプション:

Box__Security__Classification__Key

Example:

"Box__Security__Classification__Key"

fields.displayName

enum<string>

required

値は常にClassificationになります。

利用可能なオプション:

Classification

Example:

"Classification"

fields.options

object[]

required

この会社で使用できる分類のリスト。

Minimum array length: 1

表示子属性

fields.options.id

string

required

この分類の一意のID。

Example:

"46aea176-3483-4431-856c-6b5b13d1cc50"

fields.options.key

string

required

この分類の表示名とキー。

Example:

"Sensitive"

fields.options.staticConfig

object

分類に関する追加情報。

表示子属性

fields.options.staticConfig.classification

object

分類に関する追加情報。

これはプロパティの唯一のリストではなく、より多くのオブジェクトフィールドが返される場合があります。これらのフィールドは内部のBox ShieldおよびBox Governanceの目的で使用されるため、これらのフィールドからさらなる値が派生しないようにしてください。

表示子属性

fields.options.staticConfig.classification.classificationDefinition

string

分類の詳しい説明。

Example:

"Sensitive information"

fields.options.staticConfig.classification.colorID

integer<int64>

分類ラベルに色を割り当てる際に使用される内部のBox識別子。

colorIDと色の間のマッピングは予告なしに変更される場合があります。現在、色のマッピングは以下のとおりです。

0: 黄。
1: オレンジ。
2: 赤。
3: 紫。
4: ライトブルー。
5: ダークブルー。
6: ライトグリーン。
7: グレー。

Example:

4

fields.hidden

boolean

分類は常にウェブユーザーおよびモバイルユーザーに表示されます。

Example:

false

hidden

boolean

このテンプレートを常にウェブインターフェースおよびモバイルインターフェースで使用可能にするかどうかを決定します。

Example:

false

copyInstanceOnItemCopy

boolean

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

Example:

true

分類テンプレート

最初の分類を追加

⌘I