リテンションポリシーの取得
リテンションポリシーの取得
会社内に作成された特定のリテンションポリシーの情報を取得するには、ポリシーのidを指定してGET /retention_policies/:id APIエンドポイントを呼び出します。
cURL
curl -i -X GET "https://api.box.com/2.0/retention_policies/982312" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.retentionPolicies.getRetentionPolicyById(retentionPolicy.id);Python Gen
client.retention_policies.get_retention_policy_by_id(retention_policy.id).NET Gen
await client.RetentionPolicies.GetRetentionPolicyByIdAsync(retentionPolicyId: retentionPolicy.Id);Java
// Get the policy name and status for a given retention policy
BoxRetentionPolicy policy = new BoxRetentionPolicy(api, id);
policy.getInfo("policy_name", "status");Python
retention_policy = client.retention_policy(retention_id='12345').get()
print(f'Retention Policy ID is {retention_policy.id} and the name is {retention_policy.policy_name}').NET
BoxRetentionPolicy policy = await client.RetentionPoliciesManager.GetRetentionPolicyAsync("11111");Node
client.retentionPolicies.get('123456789').then((policy) => {
/* policy -> {
type: 'retention_policy',
id: '123456789',
policy_name: 'Tax Documents',
policy_type: 'indefinite',
retention_length: 'indefinite',
retention_type: 'modifiable',
description: 'Policy to retain all reports',
disposition_action: 'remove_retention',
can_owner_extend_retention: false,
status: 'active',
are_owners_notified: true,
custom_notification_recipients: []
assignment_counts: { enterprise: 0, folder: 1, metadata_template: 0 },
created_by:
{ type: 'user',
id: '11111',
name: 'Example User',
login: 'user@example.com' },
created_at: '2015-05-01T11:12:54-07:00',
modified_at: '2015-06-08T11:11:50-07:00' }
*/
});iOS
client.retentionPolicy.get(policyId: "1234") { result in
guard case let .success(retentionPolicy) = result else {
print("Error getting retention policy")
return
}
print("Retention policy: \(retentionPolicy.id)")
}必須のスコープ
リテンションポリシーAPIのいずれかを使用する前に、アプリケーションでは適切なスコープを有効にしておく必要があります。詳細については、必須のスコープを参照してください。