指定したメタデータテンプレートを指定したフォルダに適用し、そのフォルダ内のすべてのファイルに自動的にカスケードする新しいメタデータカスケードポリシーを作成します。
ポリシーを適用するには、まず、ポリシーの適用先となるフォルダにメタデータインスタンスを適用する必要があります。
1234567
ポリシーを適用するフォルダのID。このフォルダには、ターゲットメタデータテンプレートのインスタンスがすでに適用されている必要があります。
enterprise
ターゲットメタデータテンプレートのスコープ。このテンプレートでは、ターゲットフォルダにすでにインスタンスが適用されている必要があります。
次の値のいずれか1つ: global
,enterprise
productInfo
ターゲットメタデータテンプレートのキー。このテンプレートでは、ターゲットフォルダにすでにインスタンスが適用されている必要があります。
多くの場合、テンプレートキーはその表示名から自動的に派生します。たとえば、Contract Template
の場合はcontractTemplate
となります。場合によっては、テンプレートの作成者が独自のテンプレートキーを指定することもあります。
テンプレートのキーを調べるには、企業のテンプレートのリストを取得するか、ファイルまたはフォルダ上のすべてのインスタンスを取得してください。
新しいメタデータカスケードポリシーを返します
パラメータのいずれかが有効な形式でない場合はエラーを返します。
bad_request
- scope
、templateKey
、またはfolder_id
が有効な形式ではありません。制限されたフォルダ(IDが0
のルートフォルダなど)にポリシーを適用しようとした場合にエラーを返します。
forbidden
- フォルダIDが有効で、ユーザーはこのフォルダにアクセスできますが、ポリシーをこのフォルダに割り当てられませんでした。テンプレートまたはフォルダが見つからないか、ユーザーがフォルダまたはテンプレートにアクセスできない場合はエラーを返します。
instance_tuple_not_found
- テンプレートが見つからないか、ユーザーがテンプレートにアクセスできない場合に返されます。not_found
- フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。このフォルダとテンプレートのポリシーがすでに設定されている場合はエラーを返します。
tuple_already_exists
- このfolder_id
、scope
、およびtemplateKey
の組み合わせのカスケードポリシーがすでに存在する場合に返されます。予期しないクライアントエラー。
curl -i -X POST "https://api.box.com/2.0/metadata_cascade_policies" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"folder_id": "12321",
"scope": "enterprise_27335",
"templateKey": "productInfo"
}'
{
"id": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7",
"type": "metadata_cascade_policy",
"owner_enterprise": {
"id": 690678,
"type": "enterprise"
},
"parent": {
"id": 1234567,
"type": "folder"
},
"scope": "global",
"templateKey": "productInfo"
}