最新バージョン
ファイルバージョンリテンションのリストを取得
APIバージョン 2024.0
指定した会社のすべてのファイルバージョンリテンションを取得します。
注: ファイルリテンション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)クエリ内 省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
stringクエリ内省略可能
982312このIDを持つリテンションポリシーのみに結果を絞り込みます。
レスポンス
application/jsonファイルバージョンリテンション
会社のすべてのファイルバージョンリテンションのリストを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/file_version_retentions" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.fileVersionRetentions.getFileVersionRetentions();Python Gen
client.file_version_retentions.get_file_version_retentions().NET Gen
await client.FileVersionRetentions.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(f'The file version retention ID is {retention.id} and the data time applied at is {retention.applied_at}').NET
BoxCollectionMarkerBased<BoxFileVersionRetention> retentions = await client.RetentionPoliciesManager
.GetFileVersionRetentionsAsync();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' } ] }
*/
});レスポンスの例
{
"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"
}