メタデータカスケードポリシーを作成
指定したメタデータテンプレートを指定したフォルダに適用し、そのフォルダ内のすべてのファイルに自動的にカスケードする新しいメタデータカスケードポリシーを作成します。
ポリシーを適用するには、まず、ポリシーの適用先となるフォルダにメタデータインスタンスを適用する必要があります。
リクエスト
Bearer [ACCESS_TOKEN]
application/json
リクエスト本文
string本文内必須
1234567ポリシーを適用するフォルダのID。このフォルダには、ターゲットメタデータテンプレートのインスタンスがすでに適用されている必要があります。
string本文内必須
enterpriseターゲットメタデータテンプレートのスコープ。このテンプレートでは、ターゲットフォルダにすでにインスタンスが適用されている必要があります。
次の値のいずれか1つ: global,enterprise
string本文内必須
productInfoターゲットメタデータテンプレートのキー。このテンプレートでは、ターゲットフォルダにすでにインスタンスが適用されている必要があります。
レスポンス
application/jsonメタデータカスケードポリシー
新しいメタデータカスケードポリシーを返します
application/jsonクライアントエラー
パラメータのいずれかが有効な形式でない場合はエラーを返します。
bad_request-scope、templateKey、またはfolder_idが有効な形式ではありません。
application/jsonクライアントエラー
制限されたフォルダ(IDが0のルートフォルダなど)にポリシーを適用しようとした場合にエラーを返します。
forbidden- フォルダIDが有効で、ユーザーはこのフォルダにアクセスできますが、ポリシーをこのフォルダに割り当てられませんでした。
application/jsonクライアントエラー
テンプレートまたはフォルダが見つからないか、ユーザーがフォルダまたはテンプレートにアクセスできない場合はエラーを返します。
instance_tuple_not_found- テンプレートが見つからないか、ユーザーがテンプレートにアクセスできない場合に返されます。not_found- フォルダが見つからないか、ユーザーがフォルダにアクセスできない場合に返されます。
application/json競合エラー
このフォルダとテンプレートのポリシーがすでに設定されている場合はエラーを返します。
tuple_already_exists- このfolder_id、scope、およびtemplateKeyの組み合わせのカスケードポリシーがすでに存在する場合に返されます。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -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"
}'.NET
BoxMetadataCascadePolicy metadataCascadePolicy = await client.MetadataCascadePolicyManager
.CreateCascadePolicyAsync("22222", "enterprise_11111", "templateKey");Python
folder = client.folder(folder_id='22222')
metadata_template = client.metadata_template('enterprise', 'securityClassiciation')
cascade_policy = folder.cascade_metadata(metadata_template)
print('Folder {0} has a metadata cascade policy for {1} template "{2}"'.format(
cascade_policy.parent.id,
cascade_policy.scope,
cascade_policy.templateKey,
))Node
var folderID = '22222';
client.metadata.createCascadePolicy('enterprise', 'testTemplate', folderID)
.then(cascadePolicy => {
/* cascadePolicy -> {
id: '84113349-794d-445c-b93c-d8481b223434',
type: 'metadata_cascade_policy',
owner_enterprise: {
type: 'enterprise',
id: '11111'
},
parent: {
type: 'folder',
id: '22222'
},
scope: 'enterprise_11111',
templateKey: 'testTemplate'
}
*/
});レスポンスの例
{
"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"
}