フォルダにメタデータインスタンスを作成

post
https://api.box.com/2.0
/folders/:folder_id/metadata/:scope/:template_key/

メタデータテンプレートのインスタンスをフォルダに適用します。

ほとんどの場合、メタデータテンプレートに存在する値のみを使用できます。ただし、任意のキー/値ペアを使用できるglobal.propertiesテンプレートは除きます。

Boxウェブアプリでメタデータテンプレートを表示するために、会社では、管理コンソールでユーザーの [フォルダレベルメタデータのカスケード] を有効にするよう設定する必要があります。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_id123です。

Boxアカウントのルートフォルダは常にID 0で表されます。

stringパス内必須
global

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

次の値のいずれか1つ: global,enterprise

stringパス内必須
properties

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

リクエスト本文

string本文内省略可能
Aaron Levie

メタデータテンプレートに存在する各フィールドの値。

global.propertiesテンプレートの場合、汎用的なキー/値ペアをテンプレートに保存できるため、0個以上のフィールドのリストにすることができます。

レスポンス

テンプレートに適用されたデータを含む、フォルダに適用されたテンプレートのインスタンスを返します。

リクエスト本文が無効な場合にエラーを返します。

  • schema_validation_failed - リクエスト本文に、存在しないフィールドか、値またはタイプが期待されるフィールドタイプと一致しないフィールドの値が含まれています。たとえば、enumまたはmultiSelectフィールドに不明なオプションが指定されている場合があります。

フォルダテンプレートまたはメタデータテンプレートが見つからない場合はエラーを返します。

  • not_found - フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。
  • instance_tuple_not_found - メタデータテンプレートが見つからない場合に返されます。

このメタデータテンプレートのインスタンスがすでにフォルダに存在する場合はエラーを返します。

  • tuple_already_exists - メタデータテンプレートのインスタンスがすでにファイルに存在する場合に返されます。

予期しないクライアントエラー。

post
フォルダにメタデータインスタンスを作成
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
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"
     }'

レスポンスの例

{
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "marketingCollateral",
  "$version": 1
}