リーガルホールドポリシーの取得
リーガルホールドポリシーの取得
会社内に作成された特定のリーガルホールドポリシーの情報を取得するには、ポリシーのidを指定してGET /legal_hold_policies/:id APIエンドポイントを呼び出します。
cURL
curl -i -X GET "https://api.box.com/2.0/legal_hold_policies/324432" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId);Python Gen
client.legal_hold_policies.get_legal_hold_policy_by_id(legal_hold_policy_id).NET Gen
await client.LegalHoldPolicies.GetLegalHoldPolicyByIdAsync(legalHoldPolicyId: legalHoldPolicyId);Java
BoxLegalHoldPolicy policy = new BoxLegalHoldPolicy(api, id);
BoxLegalHoldPolicy.Info policyInfo = policy.getInfo();Python
legal_hold_policy = client.legal_hold_policy(policy_id='12345').get()
print(f'The "{legal_hold_policy.policy_name}" policy is {legal_hold_policy.status}').NET
BoxLegalHoldPolicy policy = await client.LegalHoldPoliciesManager.GetLegalHoldPolicyAsync("11111");Node
client.legalHoldPolicies.get('11111')
.then(policy => {
/* policy -> {
type: 'legal_hold_policy',
id: '11111',
policy_name: 'IRS Audit',
description: '',
status: 'active',
assignment_counts: { user: 1, folder: 0, file: 0, file_version: 0 },
created_by:
{ type: 'user',
id: '22222',
name: 'Example User',
login: 'user@example.com' },
created_at: '2016-05-18T10:28:45-07:00',
modified_at: '2016-05-18T11:25:59-07:00',
deleted_at: null,
filter_started_at: '2016-05-17T01:00:00-07:00',
filter_ended_at: '2016-05-21T01:00:00-07:00' }
*/
});iOS
client.legalHolds.get(policyId: "22222", fields: ["name", "created_at"]) { (result: Result<LegalHoldPolicy, BoxSDKError>) in
guard case let .success(policy) = result else {
print("Error getting policy information")
return
}
print("Legal hold policy \(policy.id) was created at \(policy.createdAt)")
}必須のスコープ
リーガルホールドAPIのいずれかを使用する前に、アプリケーションでは適切なスコープを有効にしておく必要があります。詳細については、必須のスコープを参照してください。