List legal hold policy assignments
get
https://api.box.com/2.0
/legal_hold_policy_assignments
Retrieves a list of items a legal hold policy has been assigned to.
Request
application/json
Query Parameters
stringin queryoptional
1234323Filters the results by the ID of item the policy was applied to.
stringin queryoptional
fileFilters the results by the type of item the policy was applied to.
Value is one of file,file_version,folder,user
integer / int64in queryoptional
10001000The maximum number of items to return per page.
stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiDefines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
This requires usemarker to be set to true.
stringin queryrequired
324432The ID of the legal hold policy
Response
application/jsonLegal hold policy assignments
Returns a list of legal hold policy assignments.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -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('Found policy assignment with ID {0}'.format(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
client.legalHolds.listPolicyAssignments(policyId: "1234") { results in
switch results {
case let .success(iterator):
for i in 1 ... 10 {
iterator.next { result in
switch result {
case let .success(assignment):
print("Policy Assignment \(assignment.id)")
case let .failure(error):
print(error)
}
}
}
case let .failure(error):
print(error)
}
}