フォルダのメタデータを更新します。
メタデータインスタンスを更新できるのは、テンプレートがすでにフォルダに適用されている場合のみです。メタデータを編集する際には、メタデータテンプレートのスキーマに一致した値のみを使用できます。
更新はアトミックに適用されます。操作の適用中にエラーが発生した場合、メタデータインスタンスは変更されません。
12345
フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123
の場合、folder_id
は123
です。
Boxアカウントのルートフォルダは常にID 0
で表されます。
global
メタデータテンプレートのスコープ。
次の値のいずれか1つ: global
,enterprise
properties
メタデータテンプレートの名前。
メタデータインスタンスに変更を加えるためのJSON-Patchの指定。
変更は操作オブジェクトのJSON配列として表されます。
"/nextState"
値の移動元またはコピー元であるメタデータJSONオブジェクト内の場所。move
またはcopy
操作には必須であり、JSON-Pointerの形式である必要があります。
"add"
テンプレートに対して実行する変更のタイプ。その中には、既存のテンプレートを変更する際に危険を伴うものもあります。
次の値のいずれか1つ: add
,replace
,remove
,test
,move
,copy
"/currentState"
変更を適用するメタデータJSONオブジェクト内の場所を、JSON-Pointerの形式で指定します。
パスの先頭にはテンプレートのルートを表す/
を必ず付ける必要があります。文字~
と/
は予約文字であるため、キー内ではエスケープする必要があります。
"reviewed"
設定またはテストする値。
add
、replace
、test
操作では必須です。add
の場合、値がすでに存在するときは、古い値が新しい値で上書きされます。replace
の場合、置換の前に値がすでに存在している必要があります。
test
の場合、path
の位置にある既存の値が指定した値と一致している必要があります。
カスタムテンプレートデータを含め、更新されたメタデータテンプレートインスタンスを返します。
リクエスト本文が無効な場合にエラーを返します。
bad_request
- リクエスト本文の形式が有効なJSON Patchオブジェクトの配列ではありません。リクエスト本文が有効なJSON Patch項目の配列でない場合、一部のエッジケースでエラーを返します。
予期しないクライアントエラー。