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

リテンションポリシー

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

基本
簡易
標準

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、標準バリアントに含まれるフィールドは、固有のAPIエンドポイントを介してこのリソースがリクエストされたときに返されます。 たとえば、fieldsパラメータが指定されていない場合、IDでファイルを取得すると、これらのフィールドが返されます。

User (Mini) 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
0

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

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

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

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

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

string
finite

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

次の値のいずれか1つ: finite,indefinite

string
active

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

次の値のいずれか1つ: active,retired

詳細

レスポンスの例

{
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "disposition_action": "permanently_delete",
  "id": 12345,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "policy_name": "Some Policy Name",
  "policy_type": "finite",
  "retention_length": 0,
  "status": "active",
  "type": "file_version"
}