Classifications リソース

分類ラベルは、機密性の高いコンテンツやセキュリティ上の制限が適用されるコンテンツに使用されます。

分類

ファイルまたはフォルダに適用される分類を含む、分類メタデータテンプレートのインスタンス。項目に適用される分類に関する詳細を取得するには、分類メタデータテンプレートをリクエストしてください。

属性と例

プロパティ	型	必須	説明
`Box__Security__Classification__Key`	`string`	いいえ	項目に適用される分類の名前。
`$parent`	`string`	いいえ	このメタデータインスタンスが追加されている項目の識別子。これは、親の`type`と`id`を`{type}_{id}`という形式で組み合わせたものです。
`$template`	`enum<string>`	いいえ	値は常に`securityClassification-6VMVochwUWo`になります。使用可能なオプション: `securityClassification-6VMVochwUWo`.
`$scope`	`string`	いいえ	この分類が適用されている会社のスコープ。これは`enterprise_{enterprise_id}`形式になります。
`$version`	`integer`	いいえ	メタデータインスタンスのバージョン。このバージョンは0から始まり、分類が更新されるたびに増加します。
`$type`	`string`	いいえ	この分類インスタンスの一意のID。これには、分類テンプレートの名前と一意のIDが含まれます。
`$typeVersion`	`number`	いいえ	メタデータテンプレートのバージョン。このバージョンは0から始まり、テンプレートが更新されるたびに増加します。これはほとんどの場合、内部で使用されます。
`$canEdit`	`boolean`	いいえ	エンドユーザーが分類を変更できるかどうか。

例

{
  "Box__Security__Classification__Key": "Sensitive",
  "$parent": "folder_59449484661,",
  "$template": "securityClassification-6VMVochwUWo",
  "$scope": "enterprise_27335",
  "$version": 1,
  "$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
  "$typeVersion": 5,
  "$canEdit": true
}

分類テンプレート

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

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	分類テンプレートのID。
`type`	`enum<string>`	はい	値は常に`metadata_template`になります。使用可能なオプション: `metadata_template`.
`scope`	`string`	はい	分類テンプレートのスコープ。これは`enterprise_{id}`形式 (`id`はEnterprise ID) になります。
`templateKey`	`enum<string>`	はい	値は常に`securityClassification-6VMVochwUWo`になります。使用可能なオプション: `securityClassification-6VMVochwUWo`.
`displayName`	`enum<string>`	はい	ウェブインターフェースおよびモバイルインターフェースに表示されるこのテンプレートの名前。使用可能なオプション: `Classification`.
`hidden`	`boolean`	いいえ	このテンプレートを常にウェブインターフェースおよびモバイルインターフェースで使用可能にするかどうかを決定します。
`copyInstanceOnItemCopy`	`boolean`	いいえ	ファイルまたはフォルダをコピーするときに分類もコピーするかどうかを決定します。
`fields`	array of `object`	はい	この分類テンプレートのフィールドのリスト。これには、`Box__Security__Classification__Key`というフィールドが1つだけ含まれています。これにより、この会社で使用できるさまざまな分類が定義されます。

例

{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "scope": "enterprise_123456",
  "templateKey": "securityClassification-6VMVochwUWo",
  "displayName": "Classification",
  "hidden": false,
  "copyInstanceOnItemCopy": true,
  "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
            }
          }
        }
      ]
    }
  ]
}

​分類

​分類テンプレート

分類

分類テンプレート