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

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

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

Request

Bearer [ACCESS_TOKEN]
application/json

Query Parameters

stringin queryoptional
permanently_delete

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

Value is one of permanently_delete,remove_retention

stringin queryoptional
2012-12-19T10:34:23-08:00

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

stringin queryoptional
2012-12-12T10:53:43-08:00

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

stringin queryoptional
43123123

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

stringin queryoptional
1

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

integer / int64in queryoptional
10001000

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

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

stringin queryoptional
982312

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

Response

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

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

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://api.box.com/2.0/file_version_retentions" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxCollectionMarkerBased<BoxFileVersionRetention> retentions = await client.RetentionPoliciesManager
    .GetFileVersionRetentionsAsync();
Java
BoxFileVersionRetention.QueryFilter filter = new BoxFileVersionRetention.QueryFilter()
                .addFileID("0")
                .addFileVersionID("1")
                .addPolicyID("2")
                .addDispositionAction(BoxRetentionPolicy.ACTION_PERMANENTLY_DELETE)
                .addDispositionBefore(BoxDateFormat.parse("2016-09-15T13:15:35+0000"))
                .addDispositionAfter(BoxDateFormat.parse("2014-09-15T13:15:35+0000"));
Iterable<BoxFileVersionRetention.Info> retentions
                = BoxFileVersionRetention.getRetentions(api, filter, "file", "applied_at");
for (BoxFileVersionRetention.Info retentionInfo : retentions) {
	// Do something with the file version retention.
}
Python
retentions = client.get_file_version_retentions()
for retention in retentions:
    print('The file version retention ID is {0} and the data time applied at is {1}'.format(retention.id, retention.applied_at))
Node
// Get only the retention records set to delete items before a certain date
var options = {
	disposition_action:
		client.retentionPolicies.dispositionActions.PERMANENTLY_DELETE,
	disposition_before: '2038-01-01T12:34:56-08:00',
};
client.retentionPolicies
	.getAllFileVersionRetentions(options)
	.then((retentions) => {
		/* retentions -> {
			entries:
			[ { type: 'file_version_retention', id: '112725' },
				{ type: 'file_version_retention', id: '112729' },
				{ type: 'file_version_retention', id: '112733' } ],
			limit: 100,
			order: [ { by: 'file_version_id', direction: 'ASC' } ] }
		*/
	});

Response Example

{
  "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"
      }
    }
  ],
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000
}