リテンションの対象となるファイルバージョンを取得

get
https://api.box.com/2.0
/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention/

リテンションポリシー割り当てのために、リテンションの対象となるファイルバージョンのリストを返します。

Request

Bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
1233123

リテンションポリシー割り当てのID。

Query Parameters

integer / int64in queryoptional
10001000

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

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

Response

application/jsonFiles under retention

指定したリテンションポリシー割り当てに関連付けられている、リテンションの対象となるファイルバージョンのリストを返します。

retention_policy_assignment_idが指定されていない場合は、エラーを返します。

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

get
リテンションの対象となるファイルバージョンを取得
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://app.box.com/api/2.0/retention_policy_assignments/3424234/file_versions_under_retention" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

Response Example

{
  "entries": [
    {
      "id": 12345,
      "etag": 1,
      "type": "file",
      "sequence_id": 3,
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": 12345,
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ],
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000
}