Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
最初の分類を追加
会社にまだ分類がない場合は、このAPIコールによって、分類テンプレートが最初の一連の分類で初期化されます。
会社にすでに分類がある場合は、テンプレートがすでに存在するため、さらに分類を追加するためにAPIコールが行われます。
リクエスト
リクエスト本文
falseファイルまたはフォルダをコピーするときに分類もコピーするかどうかを決定します。
"Classification"ウェブインターフェースおよびモバイルインターフェースに表示されるテンプレートの名前。
次の値に固定: Classification
分類テンプレートにはフィールドが1つだけ必要で、このフィールドでは、有効な分類の値がすべて保持されます。
"enum"常に列挙型となるフィールドのタイプ。
次の値に固定: enum
"Classification"分類の表示名。
次の値に固定: Classification
"Box__Security__Classification__Key"企業で使用できる分類を定義します。
次の値に固定: Box__Security__Classification__Key
このテンプレートに存在する実際の分類のリスト。
"Sensitive"この分類の表示名とキー。これはBox UIに表示されます。
分類に関する追加情報。
分類に関する追加情報。
"enterprise"分類を作成するスコープ。これには、enterpriseまたはenterprise_{id} (idは会社の一意のID) を指定する必要があります。
次の値に固定: enterprise
"securityClassification-6VMVochwUWo"メタデータテンプレートのリストを定義します。
次の値に固定: securityClassification-6VMVochwUWo
レスポンス
新しいsecurityClassificationメタデータテンプレートを返します。これには、この会社が使用できるすべての分類のリストを取得するBox__Security__Classification__Keyフィールドが含まれています。
リクエストパラメータのいずれかが無効な場合に返されます。
テンプレート名が正しくないときに返されます。リクエストのURLが正しいことを確認してください。
予期しないクライアントエラー。
リクエストの例
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"
}
}
}
]
}
]
}'レスポンスの例
{
"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"
}