リーガルホールドポリシー割り当てのリストを取得
リーガルホールドポリシーが割り当てられている項目のリストを取得します。
リクエスト
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>".NET
BoxCollectionMarkerBased<BoxLegalHoldPolicyAssignment> assignments = await client.LegalHoldPoliciesManager
.GetAssignmentsAsync(legalHoldPolicyId: "11111");Python
assignments = client.legal_hold_policy(policy_id='12345').get_assignments()
for assignment in assignments:
print(f'Found policy assignment with ID {assignment.id}')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"
}
],
"limit": 1000,
"next_marker": 3000,
"prev_marker": 1000
}