リテンションポリシーを更新します。
982312
リテンションポリシーのID。
false
リテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者と共同所有者に通知するかどうかを決定します。
false
元のリテンション期間が終了に近づいたときに、ポリシーが適用されている項目の所有者がリテンションを延長できるかどうかを決定します。
リテンション期間が終了に近づいたときに通知されるユーザーのリスト。
"Policy to retain all reports for at least one month"
リテンションポリシーのテキストによる追加の説明。
"permanently_delete"
リテンションポリシーの廃棄アクション。このアクションをpermanently_delete
に設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。remove_retention
に設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。disposition_action
を変更しない場合はnull
を使用できます。
"Some Policy Name"
リテンションポリシーの名前
"365"
リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーのpolicy_type
がindefinite
である場合は、retention_length
もindefinite
になります。
"non-modifiable"
以下のリテンションの種類を指定します。
modifiable
: リテンションポリシーを変更できます。たとえば、フォルダの追加と削除、ポリシー期間の短縮と延長、または割り当ての削除を行うことができます。リテンションポリシーが規制目的に関連していない場合はこの種類を使用してください。non-modifiable
: フォルダの追加、期間の延長、ポリシーの撤回、廃棄アクションまたは通知設定の変更という限られた方法でしかリテンションポリシーを変更できません。割り当ての削除やポリシー期間の短縮など、その他の操作は実行できません。規制に関するリテンションポリシーを確実に遵守する場合はこの種類を使用してください。リテンションポリシーを更新する際は、non-modifiable
の種類のみを使用できます。modifiable
ポリシーをnon-modifiable
に変換することはできますが、その逆はできません。
"retired"
リテンションポリシーを撤回する場合に使用します。
ポリシーを撤回しない場合は、このパラメータを含めないようにするか、 このパラメータをnull
に設定します。
更新されたリテンションポリシーオブジェクトを返します。
誤ったdisposition_action
が設定された場合、または説明の文字数が上限の500文字を超える場合は、bad_request
エラーを返します。
ユーザーが、変更不可ポリシーの期間を短縮しようとする場合または変更不可ポリシーを変更可能ポリシーに変換しようとする場合にエラーを返します。注: ポリシー期間の延長は許可されています。
指定した名前を持つリテンションポリシーがすでに存在する場合は、エラーを返します
予期しないクライアントエラー。
curl -i -X PUT "https://api.box.com/2.0/retention_policies/982312" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"disposition_action": "permanently_delete"
}'
{
"id": "12345",
"type": "retention_policy",
"are_owners_notified": false,
"assignment_counts": {
"enterprise": 1,
"folder": 1,
"metadata_template": 1
},
"can_owner_extend_retention": false,
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"custom_notification_recipients": [
{
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
}
],
"description": "Policy to retain all reports for at least one month",
"disposition_action": "permanently_delete",
"modified_at": "2012-12-12T10:53:43-08:00",
"policy_name": "Some Policy Name",
"policy_type": "finite",
"retention_length": "365",
"retention_type": "non_modifiable",
"status": "active"
}