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-patch+json
リクエスト本文
object array本文内必須
更新する1つ以上の分類を含む配列。
object本文内
更新された分類の詳細。
string本文内必須
"Very Sensitive"ウェブインターフェースおよびモバイルインターフェースに表示される、分類の新しいラベル。
object本文内
分類の静的な構成。
object本文内
分類の追加情報。
string本文内必須
"Sensitive"変更する分類の元のラベル。
string本文内必須
"Box__Security__Classification__Key"企業で使用できる分類を定義します。
次の値に固定: Box__Security__Classification__Key
string本文内必須
"editEnumOption"分類オブジェクトに対して実行する変更の種類。
次の値に固定: editEnumOption
レスポンス
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": "editEnumOption",
"fieldKey": "Box__Security__Classification__Key",
"enumOptionKey": "Sensitive",
"data": {
"key": "Very Sensitive",
"staticConfig": {
"classification": {
"classificationDefinition": "Sensitive information that must not be shared.",
"colorID": 4
}
}
}
}]'Node/TypeScript v10
await client.classifications.updateClassification([
new UpdateClassificationRequestBody({
enumOptionKey: classification.key,
data: {
key: updatedClassificationName,
staticConfig: {
classification: {
colorId: 2,
classificationDefinition: updatedClassificationDescription,
} satisfies UpdateClassificationRequestBodyDataStaticConfigClassificationField,
} satisfies UpdateClassificationRequestBodyDataStaticConfigField,
} satisfies UpdateClassificationRequestBodyDataField,
}),
]);Python v10
client.classifications.update_classification(
[
UpdateClassificationRequestBody(
enum_option_key=classification.key,
data=UpdateClassificationRequestBodyDataField(
key=updated_classification_name,
static_config=UpdateClassificationRequestBodyDataStaticConfigField(
classification=UpdateClassificationRequestBodyDataStaticConfigClassificationField(
color_id=2,
classification_definition=updated_classification_description,
)
),
),
)
]
).NET v10
await client.Classifications.UpdateClassificationAsync(requestBody: Array.AsReadOnly(new [] {new UpdateClassificationRequestBody(enumOptionKey: classification.Key, data: new UpdateClassificationRequestBodyDataField(key: updatedClassificationName) { StaticConfig = new UpdateClassificationRequestBodyDataStaticConfigField() { Classification = new UpdateClassificationRequestBodyDataStaticConfigClassificationField() { ColorId = 2, ClassificationDefinition = updatedClassificationDescription } } })}));Swift v10
try await client.classifications.updateClassification(requestBody: [UpdateClassificationRequestBody(enumOptionKey: classification.key, data: UpdateClassificationRequestBodyDataField(key: updatedClassificationName, staticConfig: UpdateClassificationRequestBodyDataStaticConfigField(classification: UpdateClassificationRequestBodyDataStaticConfigClassificationField(colorId: Int64(2), classificationDefinition: updatedClassificationDescription))))])Java v10
client.getClassifications().updateClassification(Arrays.asList(new UpdateClassificationRequestBody(classification.getKey(), new UpdateClassificationRequestBodyDataField.Builder(updatedClassificationName).staticConfig(new UpdateClassificationRequestBodyDataStaticConfigField.Builder().classification(new UpdateClassificationRequestBodyDataStaticConfigClassificationField.Builder().classificationDefinition(updatedClassificationDescription).colorId(2L).build()).build()).build()))).NET v6
await client.Classifications.UpdateClassificationAsync(requestBody: Array.AsReadOnly(new [] {new UpdateClassificationRequestBody(enumOptionKey: classification.Key, data: new UpdateClassificationRequestBodyDataField(key: updatedClassificationName) { StaticConfig = new UpdateClassificationRequestBodyDataStaticConfigField() { Classification = new UpdateClassificationRequestBodyDataStaticConfigClassificationField() { ColorId = 2, ClassificationDefinition = updatedClassificationDescription } } })}));Node v4
await client.classifications.updateClassification([
new UpdateClassificationRequestBody({
enumOptionKey: classification.key,
data: {
key: updatedClassificationName,
staticConfig: {
classification: {
colorId: 2,
classificationDefinition: updatedClassificationDescription,
} satisfies UpdateClassificationRequestBodyDataStaticConfigClassificationField,
} satisfies UpdateClassificationRequestBodyDataStaticConfigField,
} satisfies UpdateClassificationRequestBodyDataField,
}),
]);レスポンスの例
{
"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"
}