すべてのグローバルメタデータテンプレートのリストを取得

このリソースは、バージョン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.

Query Parameters

marker

string

結果が返される開始位置のマーカー。マーカーベースのページネーションを使用している場合に使用されます。

これを使用するには、usemarkerをtrueに設定する必要があります。

limit

integer<int64>

返す項目の1ページあたりの最大数。

必須範囲: x <= 1000

Response

すべての会社とそれに対応するスキーマで使用できるすべてのメタデータテンプレートを返します。

メタデータテンプレートのリスト。マーカーベースのページネーションについて説明しているAPIレスポンスの部分。

limit

integer<int64>

これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。

Example:

1000

next_marker

string | null

次の検索結果ページの開始場所のマーカー。

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

prev_marker

string | null

前の検索結果ページの開始場所のマーカー。

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

entries

メタデータテンプレート · object[]

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

表示子属性

entries.id

string

required

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

Example:

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

entries.type

enum<string>

required

値は常にmetadata_templateになります。

利用可能なオプション:

metadata_template

Example:

"metadata_template"

entries.scope

string

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

Example:

"enterprise_123456"

entries.templateKey

string

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

Maximum string length: 64

Example:

"productInfo"

entries.displayName

string

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

Maximum string length: 4096

Example:

"Product Info"

entries.hidden

boolean

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

Example:

true

entries.fields

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

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

表示子属性

entries.fields.type

enum<string>

required

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

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

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

利用可能なオプション:

string,

float,

date,

enum,

multiSelect,

integer

Example:

"string"

entries.fields.key

string

required

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

Maximum string length: 256

Example:

"category"

entries.fields.displayName

string

required

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

Maximum string length: 4096

Example:

"Category"

entries.fields.description

string

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

Maximum string length: 4096

Example:

"The category"

entries.fields.hidden

boolean

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

Example:

true

entries.fields.options

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

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

表示子属性

entries.fields.options.key

string

required

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

Example:

"Category 1"

entries.fields.options.id

string

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

Example:

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

entries.fields.id

string

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

Example:

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

entries.copyInstanceOnItemCopy

boolean

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

Example:

true