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

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

scope

enum<string>

required

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

利用可能なオプション:

global,

enterprise

template_key

string

required

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

Body

application/json-patch+json

enum<string>

required

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

利用可能なオプション:

editTemplate,

addField,

reorderFields,

addEnumOption,

reorderEnumOptions,

reorderMultiSelectOptions,

addMultiSelectOption,

editField,

removeField,

editEnumOption,

removeEnumOption,

editMultiSelectOption,

removeMultiSelectOption

Example:

"addEnumOption"

data

object

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

表示子属性

data.{key}

any

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

Example:

"Aaron Levie"

Example:

{ "name": "Aaron Levie" }

fieldKey

string

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

Example:

"category"

fieldKeys

string[]

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

Example:

["category", "name"]

enumOptionKey

string

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

Example:

"option1"

enumOptionKeys

string[]

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

Example:

["option1", "option2", "option3"]

multiSelectOptionKey

string

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

Example:

"option1"

multiSelectOptionKeys

string[]

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

Example:

["option1", "option2", "option3"]

Response

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

ファイルやフォルダに適用可能なメタデータのテンプレート。

string

required

メタデータテンプレートのID。

Example:

"58063d82-4128-7b43-bba9-92f706befcdf"

type

enum<string>

required

値は常にmetadata_templateになります。

利用可能なオプション:

metadata_template

Example:

"metadata_template"

scope

string

メタデータテンプレートのスコープは、globalまたはenterprise_*のいずれかになります。globalスコープは、Boxを使用するすべての会社が利用できるテンプレートに使用されます。enterprise_*スコープは、特定の会社内で作成されたテンプレートを表します (*はその会社のID)。

Example:

"enterprise_123456"

templateKey

string

テンプレートの一意の識別子。この識別子は、メタデータテンプレートが適用される会社のscope全体で一意ですが、会社を越えて一意であるとは限りません。

Maximum string length: 64

Example:

"productInfo"

displayName

string

テンプレートの表示名。Boxウェブアプリとモバイルアプリに表示されます。

Maximum string length: 4096

Example:

"Product Info"

hidden

boolean

このテンプレートをBoxウェブアプリのUIに表示するか、APIを介した使用のみを目的とするかを定義します。

Example:

true

fields

メタデータフィールド (読み取り) · object[]

テンプレートに含まれるテンプレートフィールドの順序付きリスト。各フィールドは、通常のテキストフィールド、日付フィールド、数値フィールド、単一または複数選択リストのいずれかになります。

表示子属性

fields.type

enum<string>

required

フィールドのタイプ。基本のフィールドは、テキストを表すstringフィールド、数値を表すfloatフィールド、およびユーザーに日時選択機能を表示するためのdateフィールドです。

さらに、メタデータテンプレートは、基本の項目リストを表すenumフィールドのほか、ユーザーが複数の値を選択できる同様の項目リストを表すmultiSelectフィールドをサポートしています。

注: integer値は非推奨です。レスポンスにはまだ存在していても、POSTリクエストでは使用できません。

利用可能なオプション:

string,

float,

date,

enum,

multiSelect,

integer

Example:

"string"

fields.key

string

required

フィールドの一意の識別子。この識別子は、そのフィールドが属するテンプレート内で一意である必要があります。

Maximum string length: 256

Example:

"category"

fields.displayName

string

required

ウェブアプリおよびモバイルアプリでユーザーに表示されるフィールドの表示名。

Maximum string length: 4096

Example:

"Category"

fields.description

string

フィールドの説明。ユーザーには表示されません。

Maximum string length: 4096

Example:

"The category"

fields.hidden

boolean

このフィールドをUI上でユーザーに対して非表示にし、代わりにAPIを介してのみ設定できるようにするかどうか。

Example:

true

fields.options

メタデータオプション (書き込み) · object[]

このフィールドのオプションのリスト。enumおよびmultiSelectフィールドタイプと組み合わせて使用します。このフィールドのオプションのリスト。enumおよびmultiSelectフィールドタイプと組み合わせて使用します。

表示子属性

fields.options.key

string

required

オプションのテキスト値。オプションの表示名と、テンプレートの更新時に使用される内部キーの両方を表します。オプションのテキスト値。オプションの表示名と、テンプレートの更新時に使用される内部キーの両方を表します。

Example:

"Category 1"

fields.options.id

string

オプションの内部的な一意の識別子。

Example:

"45dc2849-a4a7-40a9-a751-4a699a589190"

fields.id

string

メタデータテンプレートフィールドの一意のID。

Example:

"822227e0-47a5-921b-88a8-494760b2e6d2"

copyInstanceOnItemCopy

boolean

ファイルまたはフォルダのコピー時にメタデータを含めるかどうか。

Example:

true