メインコンテンツへスキップ
GET
/
file_version_retentions
cURL
curl -i -X GET "https://api.box.com/2.0/file_version_retentions" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "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",
        "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.

Query Parameters

​
file_id
string

このIDを持つファイルのみに結果を絞り込みます。

​
file_version_id
string

このIDを持つファイルバージョンのみに結果を絞り込みます。

​
policy_id
string

このIDを持つリテンションポリシーのみに結果を絞り込みます。

​
disposition_action
enum<string>

この廃棄アクションを使用するリテンションポリシーのみに結果を絞り込みます。

利用可能なオプション:
permanently_delete,
remove_retention
​
disposition_before
string

この日付の前に廃棄が有効になるファイルのみに結果を絞り込みます。

​
disposition_after
string

この日付の後で廃棄が有効になるファイルのみに結果を絞り込みます。

​
limit
integer<int64>

返す項目の1ページあたりの最大数。

必須範囲: x <= 1000
​
marker
string

結果が返される開始位置のマーカー。マーカーベースのページネーションを使用している場合に使用されます。

これを使用するには、usemarkerをtrueに設定する必要があります。

Response

会社のすべてのファイルバージョンリテンションのリストを返します。

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

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

​
limit
integer<int64>

これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。

Example:

1000

​
next_marker
string | null

次の検索結果ページの開始場所のマーカー。

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

​
prev_marker
string | null

前の検索結果ページの開始場所のマーカー。

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

​
entries
ファイルバージョンリテンション · object[]

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