メインコンテンツへスキップ
GET
/
file_version_retentions
/
{file_version_retention_id}
cURL
curl -i -X GET "https://api.box.com/2.0/file_version_retentions/3424234" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "id": "11446498",
  "type": "file_version_retention",
  "file_version": {
    "id": "12345",
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "file": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  },
  "applied_at": "2012-12-12T10:53:43-08:00",
  "disposition_at": "2012-12-12T10:53:43-08:00",
  "winning_retention_policy": {
    "id": "12345",
    "type": "retention_policy",
    "policy_name": "Some Policy Name",
    "retention_length": "365",
    "disposition_action": "permanently_delete"
  }
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
file_version_retention_id
string
required

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

Response

ファイルバージョンリテンションオブジェクトを返します。

リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はポリシーを特定のフォルダや企業全体に適用できます。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。この機能を使用するには、アプリケーション管理コンソールから、APIキーに対して [リテンションポリシーを管理する] スコープを有効にする必要があります。

注: ファイルリテンションAPIは非推奨になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、リテンションの対象となるファイルまたはリテンションの対象となるファイルバージョンのエンドポイントを参照してください。

​
id
string

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

Example:

"11446498"

​
type
enum<string>

値は常にfile_version_retentionになります。

利用可能なオプション:
file_version_retention
Example:

"file_version_retention"

​
file_version
ファイルバージョン (Mini) · object

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

​
file
ファイル (Mini) · object

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

​
applied_at
string<date-time>

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

Example:

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

​
disposition_at
string<date-time>

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

Example:

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

​
winning_retention_policy
リテンションポリシー (Mini) · object

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