リテンションポリシーを割り当て

post
https://api.box.com/2.0
/retention_policy_assignments/

リテンションポリシーを項目に割り当てます。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

リクエスト本文

object本文内

ポリシーを割り当てる項目

string本文内必須
6564564

ポリシーを割り当てる項目のID。

typeenterpriseに設定されている場合は、nullに設定するか省略します。

string本文内必須
folder

ポリシーを割り当てる項目のタイプ。

次の値のいずれか1つ: enterprise,folder,metadata_template

string本文内必須
173463

割り当てるリテンションポリシーのID

レスポンス

新しいリテンションポリシー割り当てオブジェクトを返します。

会社にリテンションポリシーを割り当てている最中にidが指定された場合は、エラーを返します。

指定したpolicy_idを持つリテンションポリシーが存在しない場合は、エラーを返します。

期間が同じであるか、それよりも長いリテンションポリシーがこの項目にすでに割り当てられている場合は、エラーを返します。

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

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

リクエストの例

cURL
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": 11446498,
    "type": "file"
  },
  "retention_policy": {
    "id": 12345,
    "type": "retention_policy",
    "disposition_action": "permanently_delete",
    "policy_name": "Some Policy Name",
    "retention_length": 365
  }
}