Box Developerドキュメント
 
    最新バージョン

    ファイルバージョンリテンションのリストを取得

    get
    https://api.box.com/2.0
    /file_version_retentions

    このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

    指定した会社のすべてのファイルバージョンリテンションを取得します。

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

    リクエスト

    bearer [ACCESS_TOKEN]
    application/json

    クエリパラメータ

    stringクエリ内省略可能
    permanently_delete

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

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

    stringクエリ内省略可能
    2012-12-19T10:34:23-08:00

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

    stringクエリ内省略可能
    2012-12-12T10:53:43-08:00

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

    stringクエリ内省略可能
    43123123

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

    stringクエリ内省略可能
    1

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

    integer (int64)クエリ内省略可能
    1000
    1000

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

    stringクエリ内省略可能
    JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

    stringクエリ内省略可能
    982312

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

    レスポンス

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

    予期しないクライアントエラー。

    get
    ファイルバージョンリテンションのリストを取得
    このドキュメント内で一部のAPIを試せるようになりました。
    ログイン

    リクエストの例

    cURL
    curl -i -X GET "https://api.box.com/2.0/file_version_retentions" \
         -H "authorization: Bearer <ACCESS_TOKEN>"

    レスポンスの例

    {
      "entries": [
        {
          "applied_at": "2012-12-12T10:53:43-08:00",
          "disposition_at": "2012-12-12T10:53:43-08:00",
          "file": {
            "etag": "1",
            "id": "12345",
            "type": "file",
            "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"
          },
          "id": "11446498",
          "type": "file_version_retention",
          "winning_retention_policy": {
            "id": "12345",
            "type": "retention_policy",
            "disposition_action": "permanently_delete",
            "policy_name": "Some Policy Name",
            "retention_length": "365"
          }
        }
      ],
      "limit": 1000,
      "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
      "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
    }