Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
最新バージョン
分類を追加
APIバージョン 2024.0
会社が使用できる分類のリストに1つ以上の新しい分類を追加します。
このAPIは、/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schemaのように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。
リクエスト
bearer [ACCESS_TOKEN]
application/json
リクエスト本文
object array本文内必須
会社の分類のリストに追加する1つ以上の分類を含む配列。
object本文内
追加する分類の詳細。
string本文内必須
"Sensitive"ウェブインターフェースおよびモバイルインターフェースに表示される分類のラベル。これは、分類を追加するために必要な唯一のフィールドです。
object本文内
分類の静的な構成。
object本文内
分類の追加情報。
string本文内必須
"Box__Security__Classification__Key"企業で使用できる分類を定義します。
次の値に固定: Box__Security__Classification__Key
string本文内必須
"addEnumOption"分類オブジェクトに対して実行する変更の種類。
次の値に固定: addEnumOption
レスポンス
application/json分類テンプレート
更新されたsecurityClassificationメタデータテンプレートを返します。これには、この会社が使用できるすべての分類のリストを取得するBox__Security__Classification__Keyフィールドが含まれています。
application/jsonクライアントエラー
リクエストパラメータのいずれかが無効な場合に返されます。
application/jsonクライアントエラー
テンプレート名が正しくないときに返されます。リクエストのURLが正しいことを確認してください。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
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
}
}
}
}]'Node/TypeScript v10
await client.classifications.addClassification([
new AddClassificationRequestBody({
data: {
key: getUuid(),
staticConfig: {
classification: {
colorId: 4,
classificationDefinition: 'Other description',
} satisfies AddClassificationRequestBodyDataStaticConfigClassificationField,
} satisfies AddClassificationRequestBodyDataStaticConfigField,
} satisfies AddClassificationRequestBodyDataField,
}),
]);Python v10
client.classifications.add_classification(
[
AddClassificationRequestBody(
data=AddClassificationRequestBodyDataField(
key=get_uuid(),
static_config=AddClassificationRequestBodyDataStaticConfigField(
classification=AddClassificationRequestBodyDataStaticConfigClassificationField(
color_id=4, classification_definition="Other description"
)
),
)
)
]
).NET v10
await client.Classifications.AddClassificationAsync(requestBody: Array.AsReadOnly(new [] {new AddClassificationRequestBody(data: new AddClassificationRequestBodyDataField(key: Utils.GetUUID()) { StaticConfig = new AddClassificationRequestBodyDataStaticConfigField() { Classification = new AddClassificationRequestBodyDataStaticConfigClassificationField() { ColorId = 4, ClassificationDefinition = "Other description" } } })}));Swift v10
try await client.classifications.addClassification(requestBody: [AddClassificationRequestBody(data: AddClassificationRequestBodyDataField(key: Utils.getUUID(), staticConfig: AddClassificationRequestBodyDataStaticConfigField(classification: AddClassificationRequestBodyDataStaticConfigClassificationField(colorId: Int64(4), classificationDefinition: "Other description"))))])Java v10
client.getClassifications().addClassification(Arrays.asList(new AddClassificationRequestBody(new AddClassificationRequestBodyDataField.Builder(getUuid()).staticConfig(new AddClassificationRequestBodyDataStaticConfigField.Builder().classification(new AddClassificationRequestBodyDataStaticConfigClassificationField.Builder().classificationDefinition("Other description").colorId(4L).build()).build()).build()))).NET v6
await client.Classifications.AddClassificationAsync(requestBody: Array.AsReadOnly(new [] {new AddClassificationRequestBody(data: new AddClassificationRequestBodyDataField(key: Utils.GetUUID()) { StaticConfig = new AddClassificationRequestBodyDataStaticConfigField() { Classification = new AddClassificationRequestBodyDataStaticConfigClassificationField() { ColorId = 4, ClassificationDefinition = "Other description" } } })}));Node v4
await client.classifications.addClassification([
new AddClassificationRequestBody({
data: {
key: getUuid(),
staticConfig: {
classification: {
colorId: 4,
classificationDefinition: 'Other description',
} satisfies AddClassificationRequestBodyDataStaticConfigClassificationField,
} satisfies AddClassificationRequestBodyDataStaticConfigField,
} satisfies AddClassificationRequestBodyDataField,
}),
]);レスポンスの例
{
"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"
}