メタデータテンプレートの更新
メタデータテンプレートの更新
メタデータテンプレートを更新するには、操作の配列をPUT /metadata_templates/:scope/:templateKey/schema
APIに渡します。
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"
}
}
]'
操作
メタデータテンプレートの更新は、テンプレート自体を直接変更するのではなく、操作を利用して実行されます。この方法では、ファイルおよびフォルダにすでに適用されている既存のメタデータインスタンスを更新できます。
テンプレートの操作
テンプレートの操作により、テンプレートの詳細またはフィールドが更新されます。一般的に、これらの操作は、あまり影響なくテンプレートインスタンスに適用されるため安全です。
テンプレートの編集
editTemplate
操作では、displayName
やcopyInstanceOnItemCopy
など、テンプレートの基本プロパティを編集できます。
パラメータ | |
---|---|
data | 変更するプロパティを表すオブジェクト |
[
{
"op": "editTemplate",
"data": {
"displayName": "Client",
"copyInstanceOnItemCopy": true
}
}
]
これにより、新しい表示名がClientになるようにテンプレートが更新されます。
テンプレートへのフィールドの追加
addField
操作では、テンプレートにフィールドを追加します。
パラメータ | |
---|---|
data | 追加するフィールドを表すオブジェクト |
[
{
"op": "addField",
"data": {
"displayName": "Category",
"key": "category",
"hidden": false,
"type": "string"
}
}
]
これにより、displayName
およびkey
がcategoryに指定されている、非表示ではない新しい文字列フィールドが追加されます。
フィールドの並べ替え
reorderFields
操作では、テンプレート内のフィールドのリストを、リクエストされたフィールドリストに合わせて並べ替えます。
パラメータ | |
---|---|
fieldKeys | リクエストされた順番になっているフィールドキーの新しいリスト |
{
"op": "reorderFields",
"fieldKeys": ["field2", "field1", "field3"]
}
これにより、テンプレートのフィールドは、最初にfield2
、その後field1
、field3
が続くように並べ替えられます。
フィールドの操作
フィールドの操作により、テンプレートのスキーマが変換されます。以下に、このAPIで使用できる、以前に割り当てたテンプレートのデータを変更する可能性のある操作のリストを示します。
このような変更は、ファイルの変更ではなくテンプレートの変更としてログに記録されます。
フィールドの編集
editField
操作では、displayName
、description
、key
、hidden
状態など、フィールドの基本プロパティをいくつでも編集できます。
パラメータ | |
---|---|
data | フィールドに設定する新しいプロパティを表すオブジェクト |
fieldKey | 編集するフィールドのキー |
{
"op": "editField",
"fieldKey": "category",
"data": {
"displayName": "Customer Group"
}
}
これにより、新しい表示名がCustomer Groupになるようにフィールドcategory
が更新されます。このキーが変更された場合、指定されたフィールドの既存の値は新しいキーに移行されます。検索インデックスは更新されますが、更新にかかる時間は、この変更の対象となるファイルの数によって異なります。
フィールドの削除
removeField
操作では、テンプレートからフィールドを削除します。
パラメータ | |
---|---|
fieldKey | テンプレートから削除するフィールドのキー |
{
"op": "removeField",
"fieldKey": "brand"
}
これにより、フィールドbrand
は、テンプレートに加えて、テンプレートのすべてのインスタンスから削除されます。検索インデックスは更新されますが、更新にかかる時間は、この変更の対象となるファイルの数によって異なります。
フィールドオプションの操作
enum
およびmultiSelect
メタデータフィールドタイプはどちらも、フィールドのオプションを変更するための追加操作をサポートしています。
操作 | |
---|---|
addEnumOption | enum フィールドにオプションを追加します |
editEnumOption | enum フィールドのオプションを編集します |
reorderEnumOptions | enum フィールドのオプションを並べ替えます |
removeEnumOption | enum フィールドのオプションを削除します |
addMultiSelectOption | multiSelect フィールドにオプションを追加します |
editMultiSelectOption | multiSelect フィールドのオプションを編集します |
reorderMultiSelectOptions | multiSelect フィールドのオプションを並べ替えます |
removeMultiSelectOption | multiSelect フィールドのオプションを削除します |