Box Developerドキュメント
ログイン
最新バージョン

メタデータテンプレートを更新

put
https://api.box.com/2.0
/metadata_templates/:scope/:template_key/schema

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

メタデータテンプレートを更新します。

メタデータテンプレートを更新できるのは、テンプレートがすでに存在する場合のみです。

更新はアトミックに適用されます。操作の適用中にエラー場が発生した場合、メタデータテンプレートは変更されません。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json-patch+json

パスパラメータ

stringパス内必須
global

メタデータテンプレートのスコープ。

次の値のいずれか1つ: global,enterprise

stringパス内必須
properties

メタデータテンプレートの名前。

リクエスト本文

object array本文内必須

メタデータテンプレートに変更を加えるためのJSON-Patchの指定。

変更は操作オブジェクトのJSON配列として表されます。

associative array本文内

操作するデータ。これは、実行される操作によって異なります。

object本文内
"Aaron Levie"

メタデータテンプレートに存在する各フィールドの値。global.propertiesテンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。

string本文内省略可能
"option1"

1つのenumオプションに影響する操作の場合は、影響を受けるオプションのキーを定義します。

string array本文内省略可能
["option1","option2","option3"]

複数のenumオプションに影響する操作の場合は、影響を受けるオプションのキーを定義します。

string本文内省略可能
"category"

1つのフィールドに影響する操作の場合は、影響を受けるフィールドのキーを定義します。

string array本文内省略可能
["category","name"]

複数のフィールドに影響する操作の場合は、影響を受けるフィールドのキーを定義します。

string本文内省略可能
"option1"

1つの複数選択オプションに影響する操作の場合は、影響を受けるオプションのキーを定義します。

string array本文内省略可能
["option1","option2","option3"]

複数の複数選択オプションに影響する操作の場合は、影響を受けるオプションのキーを定義します。

string本文内必須
"addEnumOption"

テンプレートに対して実行する変更のタイプ。その中には、既存のテンプレートを変更する際に危険を伴うものもあります。

次の値のいずれか1つ: editTemplate,addField,reorderFields,addEnumOption,reorderEnumOptions,reorderMultiSelectOptions,addMultiSelectOption,editField,removeField,editEnumOption,removeEnumOption,editMultiSelectOption,removeMultiSelectOption

レスポンス

application/jsonメタデータテンプレート

カスタムテンプレートデータを含め、更新されたメタデータテンプレートを返します。

application/jsonクライアントエラー

リクエスト本文に有効なメタデータスキーマが含まれていません。

application/jsonクライアントエラー

ユーザーがテンプレートを作成できないスコープがリクエスト本文に含まれています。

application/jsonクライアントエラー

リクエストしたテンプレートが見つかりませんでした。

application/jsonクライアントエラー

予期しないクライアントエラー。

put
メタデータテンプレートを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -i -X PUT "https://api.box.com/2.0/metadata_templates/enterprise/blueprintTemplate/schema" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json-patch+json" \
     -d '[
       {
         "op": "editField",
         "fieldKey": "category",
         "data": {
           "displayName": "Customer Group"
         }
       }
     ]'
Node/TypeScript v10
await client.metadataTemplates.updateMetadataTemplate(
  'enterprise' as UpdateMetadataTemplateScope,
  templateKey,
  [
    {
      op: 'addField' as UpdateMetadataTemplateRequestBodyOpField,
      fieldKey: 'newfieldname',
      data: { ['type']: 'string', ['displayName']: 'newFieldName' },
    } satisfies UpdateMetadataTemplateRequestBody,
  ],
);
Python v10
client.metadata_templates.update_metadata_template(
    UpdateMetadataTemplateScope.ENTERPRISE,
    template_key,
    [
        UpdateMetadataTemplateRequestBody(
            op=UpdateMetadataTemplateRequestBodyOpField.ADDFIELD,
            field_key="newfieldname",
            data={"type": "string", "displayName": "newFieldName"},
        )
    ],
)
.NET v10
await client.MetadataTemplates.UpdateMetadataTemplateAsync(scope: UpdateMetadataTemplateScope.Enterprise, templateKey: templateKey, requestBody: Array.AsReadOnly(new [] {new UpdateMetadataTemplateRequestBody(op: UpdateMetadataTemplateRequestBodyOpField.AddField) { FieldKey = "newfieldname", Data = new Dictionary<string, object>() { { "type", "string" }, { "displayName", "newFieldName" } } }}));
Swift v10
try await client.metadataTemplates.updateMetadataTemplate(scope: UpdateMetadataTemplateScope.enterprise, templateKey: templateKey, requestBody: [UpdateMetadataTemplateRequestBody(op: UpdateMetadataTemplateRequestBodyOpField.addField, fieldKey: "newfieldname", data: ["type": "string", "displayName": "newFieldName"])])
Java v10
client.getMetadataTemplates().updateMetadataTemplate(UpdateMetadataTemplateScope.ENTERPRISE, templateKey, Arrays.asList(new UpdateMetadataTemplateRequestBody.Builder(UpdateMetadataTemplateRequestBodyOpField.ADDFIELD).data(mapOf(entryOf("type", "string"), entryOf("displayName", "newFieldName"))).fieldKey("newfieldname").build()))
.NET v6
await client.MetadataTemplates.UpdateMetadataTemplateAsync(scope: UpdateMetadataTemplateScope.Enterprise, templateKey: templateKey, requestBody: Array.AsReadOnly(new [] {new UpdateMetadataTemplateRequestBody(op: UpdateMetadataTemplateRequestBodyOpField.AddField) { FieldKey = "newfieldname", Data = new Dictionary<string, object>() { { "type", "string" }, { "displayName", "newFieldName" } } }}));
Node v4
await client.metadataTemplates.updateMetadataTemplate(
  'enterprise' as UpdateMetadataTemplateScope,
  templateKey,
  [
    {
      op: 'addField' as UpdateMetadataTemplateRequestBodyOpField,
      fieldKey: 'newfieldname',
      data: { ['type']: 'string', ['displayName']: 'newFieldName' },
    } satisfies UpdateMetadataTemplateRequestBody,
  ],
);

レスポンスの例

{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "copyInstanceOnItemCopy": true,
  "displayName": "Product Info",
  "fields": [
    {
      "description": "The category",
      "displayName": "Category",
      "hidden": true,
      "key": "category",
      "options": [
        {
          "key": "Category 1",
          "id": "45dc2849-a4a7-40a9-a751-4a699a589190"
        }
      ],
      "type": "string",
      "id": "822227e0-47a5-921b-88a8-494760b2e6d2"
    }
  ],
  "hidden": true,
  "scope": "enterprise_123456",
  "templateKey": "productInfo"
}