ファイルバージョンリテンション

リテンションポリシーは、指定した期間にわたってコンテンツが完全に消去されるのを防止します。管理者はポリシーを特定のフォルダや会社全体に適用できます。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。この機能を使用するには、アプリケーション管理コンソールから、APIキーに対してリテンションポリシーを管理スコープを有効にする必要があります。リテンションポリシーについて詳しくは、Boxのヘルプドキュメントをご覧ください

applied_at string / date-time

例2012-12-12T10:53:43-08:00

このファイルバージョンリテンションオブジェクトが作成された日時

disposition_at string / date-time

例2012-12-12T10:53:43-08:00

このファイルバージョンリテンションのリテンションが終了する日時

fileFile (Mini) object

このファイルバージョンリテンションが適用されたファイル

file_versionFile version (Mini) object

このファイルバージョンリテンションが適用されたファイルバージョン

id string

例11446498

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

type string

例file_version_retention

次の値に固定: file_version_retention

winning_retention_policyRetention policy (Mini) object

このファイルバージョンリテンションに適用されている、優先度が最も高いリテンションポリシー。ファイルバージョンには複数のリテンションポリシーが適用されている場合があります。

レスポンスの例

{
  "applied_at": "2012-12-12T10:53:43-08:00",
  "disposition_at": "2012-12-12T10:53:43-08:00",
  "file": {
    "etag": 1,
    "id": 12345,
    "name": "Contract.pdf",
    "sequence_id": 3,
    "type": "file"
  },
  "file_version": {
    "id": 12345,
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
    "type": "file_version"
  },
  "id": 11446498,
  "type": "file_version_retention",
  "winning_retention_policy": {
    "disposition_action": "permanently_delete",
    "id": 12345,
    "policy_name": "Some Policy Name",
    "retention_length": 0,
    "type": "file_version"
  }
}