> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。

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

リテンションポリシーは、指定した期間にわたってコンテンツが完全に削除されるのを防止します。管理者はポリシーを特定のフォルダや企業全体に適用できます。ファイルバージョンリテンションとは、保持されているファイルバージョンのレコードです。この機能を使用するには、アプリケーション管理コンソールから、APIキーに対して \[リテンションポリシーを管理する] スコープを有効にする必要があります。 **注**: ファイルリテンションAPIは**非推奨**になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、[リテンションの対象となるファイル](/reference/get-retention-policy-assignments-id-files-under-retention)または[リテンションの対象となるファイルバージョン](/reference/get-retention-policy-assignments-id-file-versions-under-retention)のエンドポイントを参照してください。

<Accordion title="属性と例">
  | プロパティ                      | 型                                                                     | 必須  | 説明                                                                                    |
  | -------------------------- | --------------------------------------------------------------------- | --- | ------------------------------------------------------------------------------------- |
  | `id`                       | `string`                                                              | いいえ | このファイルバージョンリテンションの一意の識別子。                                                             |
  | `type`                     | `enum<string>`                                                        | いいえ | 値は常に`file_version_retention`になります。 使用可能なオプション: `file_version_retention`.              |
  | `file_version`             | `ファイルバージョン (Mini)`                                                    | いいえ | このファイルバージョンリテンションが適用されたファイルバージョン。                                                     |
  | `file`                     | [ファイル (Mini)](/ja/reference/files-resources#-mini)                    | いいえ | このファイルバージョンリテンションが適用されたファイル。                                                          |
  | `applied_at`               | `string`                                                              | いいえ | このファイルバージョンリテンションオブジェクトが作成された日時。                                                      |
  | `disposition_at`           | `string`                                                              | いいえ | このファイルバージョンリテンションのリテンションが終了する日時。                                                      |
  | `winning_retention_policy` | [リテンションポリシー (Mini)](/ja/reference/retention-policies-resources#-mini) | いいえ | このファイルバージョンリテンションに適用されている、優先度が最も高いリテンションポリシー。ファイルバージョンには複数のリテンションポリシーが適用されている場合があります。 |

  ```json 例 theme={null}
  {
    "id": "11446498",
    "type": "file_version_retention",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "file": {
      "id": "12345",
      "etag": "1",
      "type": "file",
      "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",
      "max_extension_length": "365"
    }
  }
  ```
</Accordion>

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

ファイルバージョンリテンションのリスト。 **注**: ファイルリテンションAPIは**非推奨**になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、[リテンションの対象となるファイル](/reference/get-retention-policy-assignments-id-files-under-retention)または[リテンションの対象となるファイルバージョン](/reference/get-retention-policy-assignments-id-file-versions-under-retention)のエンドポイントを参照してください。

<Accordion title="属性と例">
  | プロパティ         | 型                             | 必須  | 説明                                                                             |
  | ------------- | ----------------------------- | --- | ------------------------------------------------------------------------------ |
  | `limit`       | `integer`                     | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。 |
  | `next_marker` | `string`                      | いいえ | 次の検索結果ページの開始場所のマーカー。 `null` を指定できます。                                           |
  | `prev_marker` | `string`                      | いいえ | 前の検索結果ページの開始場所のマーカー。 `null` を指定できます。                                           |
  | `entries`     | array of [ファイルバージョンリテンション](#) | いいえ | ファイルバージョンリテンションのリスト。                                                           |

  ```json 例 theme={null}
  {
    "limit": 1000,
    "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
    "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
    "entries": [
      {
        "id": "11446498",
        "type": "file_version_retention",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "file": {
          "id": "12345",
          "etag": "1",
          "type": "file",
          "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",
          "max_extension_length": "365"
        }
      }
    ]
  }
  ```
</Accordion>