リーガルホールドポリシー割り当てのリストを取得
リーガルホールドポリシーが割り当てられている項目のリストを取得します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
stringクエリ内省略可能
1234323ポリシーが割り当てられている項目のIDのみに結果を絞り込みます。
stringクエリ内省略可能
fileポリシーが適用されている項目のタイプのみに結果を絞り込みます。
次の値のいずれか1つ: file,file_version,folder,user
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
integer (int64)クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
stringクエリ内必須
324432リーガルホールドポリシーのID
レスポンス
application/jsonリーガルホールドポリシー割り当て
リーガルホールドポリシー割り当てのリストを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/legal_hold_policy_assignments?policy_id=324432" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignments({
policyId: legalHoldPolicyId,
} satisfies GetLegalHoldPolicyAssignmentsQueryParams);Python Gen
client.legal_hold_policy_assignments.get_legal_hold_policy_assignments(
legal_hold_policy_id
).NET Gen
await client.LegalHoldPolicyAssignments.GetLegalHoldPolicyAssignmentsAsync(queryParams: new GetLegalHoldPolicyAssignmentsQueryParams(policyId: legalHoldPolicyId));Python
assignments = client.legal_hold_policy(policy_id='12345').get_assignments()
for assignment in assignments:
print(f'Found policy assignment with ID {assignment.id}').NET
BoxCollectionMarkerBased<BoxLegalHoldPolicyAssignment> assignments = await client.LegalHoldPoliciesManager
.GetAssignmentsAsync(legalHoldPolicyId: "11111");Node
client.legalHoldPolicies.getAssignments('8763245', {assign_to_type: 'folder'})
.then(assignments => {
/* assignments -> {
entries: [ { type: 'legal_hold_policy_assignment', id: '22222' } ],
limit: 100,
next_marker: 'someMarkerString' }
*/
});iOS
let iterator = client.legalHolds.listPolicyAssignments(policyId: "1234")
iterator.next { results in
switch results {
case let .success(page):
for assignment in page.entries {
print("Policy Assignment \(assignment.id)")
}
case let .failure(error):
print(error)
}
}レスポンスの例
{
"entries": [
{
"id": "11446498",
"type": "legal_hold_policy_assignment",
"legal_hold_policy": {
"id": "11446498",
"type": "legal_hold_policy"
},
"assigned_to": {
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
},
"description": "Contract for Q1 renewal",
"size": 629644,
"path_collection": {
"total_count": 1,
"entries": [
{
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
}
]
},
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"trashed_at": "2012-12-12T10:53:43-08:00",
"purged_at": "2012-12-12T10:53:43-08:00",
"content_created_at": "2012-12-12T10:53:43-08:00",
"content_modified_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"modified_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"owned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"vanity_url": "https://acme.app.box.com/v/my_url/",
"vanity_name": "my_url",
"access": "open",
"effective_access": "company",
"effective_permission": "can_download",
"unshared_at": "2018-04-13T13:53:23-07:00",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_preview": true,
"can_edit": false
},
"download_count": 3,
"preview_count": 3
},
"parent": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"item_status": "active"
},
"assigned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"assigned_at": "2012-12-12T10:53:43-08:00",
"deleted_at": "2012-12-12T10:53:43-08:00"
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}