リテンションポリシーを更新

put
https://api.box.com/2.0
/retention_policies/:retention_policy_id/

リテンションポリシーを更新します。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
982312

リテンションポリシーのID。

リクエスト本文

string本文内省略可能
permanently_delete

リテンションポリシーの廃棄アクション。 このアクションをpermanently_deleteに設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。remove_retentionに設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。

次の値のいずれか1つ: permanently_delete,remove_retention

string本文内省略可能
Some Policy Name

リテンションポリシーの名前

string本文内省略可能
retired

次の値に固定: retired

レスポンス

更新されたリテンションポリシーオブジェクトを返します。

誤ったdisposition_actionが設定された場合は、bad_requestを返します。

指定した名前を持つリテンションポリシーがすでに存在する場合は、エラーを返します

予期しないクライアントエラー。

put
リテンションポリシーを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
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",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "disposition_action": "permanently_delete",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "policy_name": "Some Policy Name",
  "policy_type": "finite",
  "retention_length": 365,
  "status": "active"
}