Box開発者向けドキュメントポータル
ログイン

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

管理者はリテンションポリシー割り当てエンドポイントを使用して、フォルダごとにリテンションポリシーを適用したり、会社全体を対象とした包括的なポリシーを設定したりすることができます。

string
11446498

このリテンションポリシー割り当ての一意の識別子

string
retention_policy_assignment

次の値に固定: retention_policy_assignment

string / date-time
2012-12-12T10:53:43-08:00

リテンションポリシー割り当てオブジェクトが作成された日時

object

リテンションポリシー割り当てオブジェクトを作成したユーザーを表す、簡易版のユーザーオブジェクト

string
11446498

このユーザーの一意の識別子

string
user

次の値に固定: user

string / email
ceo@example.com

このユーザーのプライマリメールアドレス

string
Aaron Levie50

このユーザーの表示名

object

リテンションの対象となるコンテンツのtypeとid。typeは、folderまたはenterpriseのいずれかになります。

string
11446498

このオブジェクトの一意の識別子

string
file

このオブジェクトのタイプ

object

このコンテンツに割り当てられたリテンションポリシーを表す簡易版リテンションポリシーオブジェクト

string
12345

ファイルバージョンを表す一意の識別子。

string
file_version

次の値に固定: file_version

string
permanently_delete

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

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

string
Some Policy Name

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

string / int32
3651

リテンションポリシーの期間。これはリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーのpolicy_typeがindefiniteである場合は、retention_lengthもindefiniteになります。

レスポンスの例

{
  "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": "file_version",
    "disposition_action": "permanently_delete",
    "policy_name": "Some Policy Name",
    "retention_length": 365
  }
}