最新バージョン
リテンションポリシーのリストを取得
APIバージョン 2024.0
会社のすべてのリテンションポリシーを取得します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
stringクエリ内省略可能
21312321ポリシーを作成したユーザーのIDのみに結果を絞り込みます。
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
integer (int64)クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
stringクエリ内省略可能
Sales Policy指定したプレフィックスを持つリテンションポリシー名のみに結果を絞り込みます。このフィルタでは大文字と小文字が区別されます。
stringクエリ内省略可能
finite指定したタイプのリテンションポリシーのみに結果を絞り込みます。
次の値のいずれか1つ: finite,indefinite
レスポンス
application/jsonリテンションポリシー
企業のリテンションポリシーのリストを返します。
application/jsonクライアントエラー
存在しないpolicy_typeが指定された場合は、bad_requestを返します。
application/jsonクライアントエラー
created_by_user_idで指定されたユーザーが存在しない場合は、not_foundエラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/retention_policies" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.retentionPolicies.getRetentionPolicies();Python Gen
client.retention_policies.get_retention_policies().NET Gen
await client.RetentionPolicies.GetRetentionPoliciesAsync();Java
Iterable<BoxRetentionPolicy.Info> policies = BoxRetentionPolicy.getAll(api);
for (BoxRetentionPolicy.Info policyInfo : policies) {
// Do something with the retention policy.
}Python
retention_policies = client.get_retention_policies()
for policy in retention_policies:
print(f'The policy ID is {policy.id} and the name is {policy.policy_name}').NET
BoxCollectionMarkerBased<BoxRetentionPolicy> policies = await client.RetentionPoliciesManager
.GetRetentionPoliciesAsync();Node
client.retentionPolicies.getAll({ policy_name: 'Tax' }).then((policies) => {
/* policies -> {
entries:
[ { type: 'retention_policy',
id: '123456789',
name: 'Tax Documents' } ],
limit: 100,
next_marker: 'someMarkerString' }
*/
});iOS
let iterator = client.retentionPolicy.list(type: .indefinite)
iterator.next { results in
switch results {
case let .success(page):
for policy in page.entries {
print("Retention policy \(policy.id)")
}
case let .failure(error):
print(error)
}
}レスポンスの例
{
"entries": [
{
"id": "12345",
"type": "retention_policy",
"disposition_action": "permanently_delete",
"policy_name": "Some Policy Name",
"retention_length": "365",
"are_owners_notified": false,
"assignment_counts": {
"enterprise": 1,
"folder": 1,
"metadata_template": 1
},
"can_owner_extend_retention": false,
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"custom_notification_recipients": [
{
"id": "11446498",
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
}
],
"description": "Policy to retain all reports for at least one month",
"modified_at": "2012-12-12T10:53:43-08:00",
"policy_type": "finite",
"retention_type": "non_modifiable",
"status": "active"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}