メタデータテンプレート

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

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