リテンションポリシー

リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はリテンションポリシーを作成して特定のフォルダや会社全体に割り当てることができます。この機能を使用するには、アプリケーション管理コンソールから、APIキーに対してリテンションポリシーを管理スコープを有効にする必要があります。

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
12345

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

string
retention_policy

Value is always retention_policy

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

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

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

permanently_delete

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

Value is one of permanently_delete,remove_retention

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

リテンションポリシーオブジェクトが最後に変更された日時

Some Policy Name

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

finite

リテンションポリシーのタイプ。リテンションポリシーのタイプは、finite (コンテンツを保持する期間が事前にわかっている場合)、またはindefinite (コンテンツを保持する期間が不明な場合)のいずれかになります。

Value is one of finite,indefinite

string / int32
3651

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

string
active

リテンションポリシーのステータス。ポリシーのステータスは、管理者が明示的に撤回しない限り、activeになります (撤回されたポリシーのステータスはretiredになります)。一度廃止したポリシーを再度アクティブにすることはできません。

Value is one of active,retired

Response Example

{
  "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"
}