リテンションポリシーのリストを取得

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

会社のすべてのリテンションポリシーを取得します。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

stringクエリ内省略可能
21312321

ポリシーを作成したユーザーのIDのみに結果を絞り込みます。

stringクエリ内省略可能
Sales Policy

指定したプレフィックスを持つリテンションポリシー名のみに結果を絞り込みます。このフィルタでは大文字と小文字が区別されます。

stringクエリ内省略可能
finite

指定したタイプのリテンションポリシーのみに結果を絞り込みます。

次の値のいずれか1つ: finite,indefinite

レスポンス

会社のリテンションポリシーのリストを返します。

存在しないpolicy_typeが指定された場合は、bad_requestを返します。

created_by_user_idで指定されたユーザーが存在しない場合は、not_foundエラーを返します。

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

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

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/retention_policies" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxCollectionMarkerBased<BoxRetentionPolicy> policies = await client.RetentionPoliciesManager
    .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('The policy ID is {0} and the name is {1}'.format(policy.id, policy.policy_name))
Node
client.retentionPolicies.getAll({ policy_name: 'Tax' })
	.then(policies => {
		/* policies -> {
			entries: 
			[ { type: 'retention_policy',
				id: '123456789',
				name: 'Tax Documents' } ],
			limit: 100,
			next_marker: 'someMarkerString' }
		*/
	});

レスポンスの例

{
  "entries": [
    {
      "id": 12345,
      "type": "file_version",
      "policy_name": "Some Policy Name",
      "retention_length": 365,
      "disposition_action": "permanently_delete",
      "policy_type": "finite",
      "status": "active",
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00"
    }
  ],
  "total_count": 156
}