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

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

string
11446498

このファイルバージョンリテンションの一意の識別子。

string
file_version_retention

次の値に固定: file_version_retention

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

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

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

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

object

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

string
12345

ファイルを表す一意の識別子。

ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_id123です。

string
file

次の値に固定: file

string
1

このファイルのHTTP etag。これは変更が発生した場合(またはしなかった場合)にファイルに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。

ファイルの現在のバージョンに関する情報。

12345

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

file_version

次の値に固定: file_version

134b65991ed521fcfe4724b7d814ab8ded5185dc

ファイルの現在のバージョンのSHA1ハッシュ。

string
Contract.pdf

ファイルの名前

3

この項目に適用された最新のユーザーイベントを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるユーザーイベントを除外できます。

たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するユーザーイベントの発生を監視する場合などがこれに該当します。ユーザーイベントのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなユーザーイベントをすべて無視します。

string / digest
85136C79CBF9FE36BB9D05D0639C70C265C18D37

ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。

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

12345

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

file_version

次の値に固定: file_version

134b65991ed521fcfe4724b7d814ab8ded5185dc

ファイルの現在のバージョンのSHA1ハッシュ。

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

12345

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

file_version

次の値に固定: file_version

permanently_delete

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

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

Some Policy Name

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

3651

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

レスポンスの例

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