APIバージョン 2024.0
ファイルやフォルダに適用可能なメタデータのテンプレート。
例 58063d82-4128-7b43-bba9-92f706befcdfメタデータテンプレートのID。
例 metadata_template値は常にmetadata_templateになります。次の値に固定: metadata_template
例 trueファイルまたはフォルダのコピー時にメタデータを含めるかどうか。
例 Product Infoテンプレートの表示名。Boxウェブアプリとモバイルアプリに表示されます。
テンプレートに含まれるテンプレートフィールドの順序付きリスト。各フィールドは、通常のテキストフィールド、日付フィールド、数値フィールド、単一または複数選択リストのいずれかになります。
例 822227e0-47a5-921b-88a8-494760b2e6d2メタデータテンプレートフィールドの一意のID。
例 stringフィールドのタイプ。基本のフィールドは、テキストを表すstringフィールド、数値を表すfloatフィールド、およびユーザーに日時選択機能を表示するためのdateフィールドです。さらに、メタデータテンプレートは、基本の項目リストを表すenumフィールドのほか、ユーザーが複数の値を選択できる同様の項目リストを表す multiSelectフィールドをサポートしています。注: integer値は非推奨です。レスポンスにはまだ存在していても、POSTリクエストでは使用できません。次の値のいずれか1つ: string,float,date,enum,multiSelect,integer
例 The categoryフィールドの説明。ユーザーには表示されません。
例 Categoryウェブアプリおよびモバイルアプリでユーザーに表示されるフィールドの表示名。
例 trueこのフィールドをUI上でユーザーに対して非表示にし、代わりにAPIを介してのみ設定できるようにするかどうか。
例 categoryフィールドの一意の識別子。この識別子は、そのフィールドが属するテンプレート内で一意である必要があります。
このフィールドのオプションのリスト。enumおよびmultiSelectフィールドタイプと組み合わせて使用します。
例 45dc2849-a4a7-40a9-a751-4a699a589190オプションの内部的な一意の識別子。
例 Category 1オプションのテキスト値。オプションの表示名と、テンプレートの更新時に使用される内部キーの両方を表します。
例 trueこのテンプレートをBoxウェブアプリのUIに表示するか、APIを介した使用のみを目的とするかを定義します。
例 enterprise_123456メタデータテンプレートのスコープは、globalまたはenterprise_*のいずれかになります。globalスコープは、Boxを使用するすべての会社が利用できるテンプレートに使用されます。enterprise_*スコープは、特定の会社内で作成されたテンプレートを表します (*はその会社のID)。
例 ^[a-zA-Z_][-a-zA-Z0-9_]*$テンプレートの一意の識別子。この識別子は、メタデータテンプレートが適用される会社のscope全体で一意ですが、会社を越えて一意であるとは限りません。
{
"id": "58063d82-4128-7b43-bba9-92f706befcdf",
"type": "metadata_template",
"copyInstanceOnItemCopy": true,
"displayName": "Product Info",
"fields": [
{
"description": "The category",
"displayName": "Category",
"hidden": true,
"key": "category",
"options": [
{
"key": "Category 1",
"id": "45dc2849-a4a7-40a9-a751-4a699a589190"
}
],
"type": "string",
"id": "822227e0-47a5-921b-88a8-494760b2e6d2"
}
],
"hidden": true,
"scope": "enterprise_123456",
"templateKey": "productInfo"
}
