リーガルホールドポリシー割り当てのリストを取得

get
https://api.box.com/2.0
/legal_hold_policy_assignments/

リーガルホールドポリシーが割り当てられている項目のリストを取得します。

Request

Bearer [ACCESS_TOKEN]
application/json

Query Parameters

stringin queryoptional
1234323

ポリシーが割り当てられている項目のIDのみに結果を絞り込みます。

stringin queryoptional
file

ポリシーが適用されている項目のタイプのみに結果を絞り込みます。

Value is one of file,file_version,folder,user

string arrayin queryoptional
id,type,name

レスポンスに含める属性のカンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

integer / int64in queryoptional
10001000

返す項目の1ページあたりの最大数。

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

これを使用するには、usemarkertrueに設定する必要があります。

stringin queryrequired
324432

リーガルホールドポリシーのID

Response

リーガルホールドポリシー割り当てのリストを返します。

予期しないクライアントエラー。

get
リーガルホールドポリシー割り当てのリストを取得
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

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('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
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)
    }

}

Response Example

{
  "entries": [
    {
      "id": 11446498,
      "type": "legal_hold_policy_assignment"
    }
  ],
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000
}