メタデータテンプレートのインスタンスをフォルダに適用します。
ほとんどの場合、メタデータテンプレートに存在する値のみを使用できます。ただし、任意のキー/値ペアを使用できるglobal.properties
テンプレートは除きます。
Boxウェブアプリでメタデータテンプレートを表示するために、企業では、管理コンソールでユーザーの [フォルダレベルメタデータのカスケード] を有効にするよう設定する必要があります。
12345
フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123
の場合、folder_id
は123
です。
Boxアカウントのルートフォルダは常にID 0
で表されます。
global
メタデータテンプレートのスコープ
次の値のいずれか1つ: global
,enterprise
properties
メタデータテンプレートの名前
"Aaron Levie"
メタデータテンプレートに存在する各フィールドの値。global.properties
テンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。
テンプレートに適用されたデータを含む、フォルダに適用されたテンプレートのインスタンスを返します。
リクエスト本文が無効な場合にエラーを返します。
schema_validation_failed
- リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、enum
またはmultiSelect
フィールドに不明なオプションが指定されている場合があります。フォルダテンプレートまたはメタデータテンプレートが見つからなかった場合にエラーを返します。
not_found
- フォルダが見つからないか、ユーザーがフォルダにアクセスできません。instance_tuple_not_found
- メタデータテンプレートが見つかりませんでした。このメタデータテンプレートのインスタンスがすでにフォルダに存在する場合はエラーを返します。
tuple_already_exists
- メタデータテンプレートのインスタンスがすでにファイルに存在する場合に返されます。予期しないクライアントエラー。
curl -i -X POST "https://api.box.com/2.0/folders/4353455/metadata/enterprise_27335/blueprintTemplate" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"audience": "internal",
"documentType": "Q1 plans",
"competitiveDocument": "no",
"status": "active",
"author": "Jones",
"currentState": "proposal"
}'
{
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661,",
"$scope": "enterprise_27335",
"$template": "marketingCollateral",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}