リテンションポリシーを項目に割り当てます。
ポリシーを割り当てる項目
"6564564"
ポリシーを割り当てる項目のID。type
がenterprise
に設定されている場合は、null
に設定するか省略します。
"metadata_template"
ポリシーを割り当てる項目のタイプ。
次の値のいずれか1つ: enterprise
,folder
,metadata_template
assign_to
のタイプがmetadata_template
の場合は、必要に応じてfilter_fields
パラメータを追加します。このパラメータには、フィールドエントリと値エントリを含むオブジェクトの配列が必要になります。現在、field
およびvalue
のオブジェクトは1つだけサポートされています。
"a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4"
メタデータ属性キーID。
"0c27b756-0p87-4fe0-a43a-59fb661ccc4e"
メタデータ属性フィールドID。値については、列挙型とmultiselect型のみがサポートされています。
"173463"
割り当てるリテンションポリシーのID
"upload_date"
リテンションポリシー割り当ての開始日。
assigned_to
のタイプがmetadata_template
の場合、このフィールドには、日付フィールドのメタデータ属性キーIDを指定できます。
新しいリテンションポリシー割り当てオブジェクトを返します。
企業にリテンションポリシーを割り当てている最中にid
が指定された場合は、エラーを返します。
start_date_field
が存在するものの、assign_to.type
がmetadata_template
でない場合は、エラーを返します。
start_date_field
が存在するものの、assign_to.id
で指定されたものとは異なるメタデータテンプレートに属している場合は、エラーを返します。
start_date_field
が存在するものの、retention_policy
のretention_length
が「indefinite」である場合は、エラーを返します。
start_date_field
が存在するものの、有効なメタデータの日付フィールドに解決できない場合は、エラーを返します。
指定したpolicy_id
を持つリテンションポリシーが存在しない場合は、エラーを返します。
期間が同じであるか、それよりも長いリテンションポリシーがこの項目にすでに割り当てられている場合は、エラーを返します。
予期しないクライアントエラー。
curl -i -X POST "https://api.box.com/2.0/retention_policy_assignments" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"policy_id": "173463",
"assign_to": {
"type": "folder",
"id": "6564564"
}
}'
{
"id": "11446498",
"type": "retention_policy_assignment",
"assigned_at": "2012-12-12T10:53:43-08:00",
"assigned_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"assigned_to": {
"id": "a983f69f-e85f-4ph4-9f46-4afdf9c1af65",
"type": "metadata_template"
},
"filter_fields": [
{
"field": "a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4",
"value": "0c27b756-0p87-4fe0-a43a-59fb661ccc4e"
}
],
"retention_policy": {
"id": "12345",
"type": "retention_policy",
"disposition_action": "permanently_delete",
"policy_name": "Some Policy Name",
"retention_length": "365"
},
"start_date_field": "upload_date"
}