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

承認

Authorization

string

header

必須

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

パスパラメータ

scope

enum<string>

必須

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

利用可能なオプション:

global,

enterprise

template_key

string

必須

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

ボディ

application/json-patch+json

enum<string>

必須

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

利用可能なオプション:

editTemplate,

addField,

reorderFields,

addEnumOption,

reorderEnumOptions,

reorderMultiSelectOptions,

addMultiSelectOption,

editField,

removeField,

editEnumOption,

removeEnumOption,

editMultiSelectOption,

removeMultiSelectOption

例:

"addEnumOption"

data

object

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

Show child attributes

例:

{ "name": "Aaron Levie" }

fieldKey

string

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

例:

"category"

fieldKeys

string[]

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

例:

["category", "name"]

enumOptionKey

string

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

例:

"option1"

enumOptionKeys

string[]

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

例:

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

multiSelectOptionKey

string

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

例:

"option1"

multiSelectOptionKeys

string[]

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

例:

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

レスポンス

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

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

string

必須

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

例:

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

type

enum<string>

必須

値は常にmetadata_templateになります。

利用可能なオプション:

metadata_template

例:

"metadata_template"

scope

string

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

例:

"enterprise_123456"

templateKey

string

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

Maximum string length: 64

Pattern: ^[a-zA-Z_][-a-zA-Z0-9_]*$

例:

"productInfo"

displayName

string

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

Maximum string length: 4096

例:

"Product Info"

hidden

boolean

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

例:

true

fields

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

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

Show child attributes

copyInstanceOnItemCopy

boolean

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

例:

true

Documentation Index

承認

パスパラメータ

ボディ

レスポンス