ガイドリテンションポリシーすべてのリテンションポリシーのリストの取得

すべてのリテンションポリシーのリストの取得

すべてのリテンションポリシーのリストの取得

会社内に作成されたすべてのリテンションポリシーのリストを取得するには、GET /retention_policies APIエンドポイントを呼び出します。

cURL
curl -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' }
		*/
	});

必須のスコープ

リテンションポリシーAPIのいずれかを使用する前に、アプリケーションでは適切なスコープを有効にしておく必要があります。詳細については、必須のスコープを参照してください。