すべてのリーガルホールドポリシーのリストを取得
会社に属するリーガルホールドポリシーのリストを取得します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のカンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
integer / int64クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
stringクエリ内省略可能
"Sales Policy"名前がこの検索語で始まるポリシーのみに結果を絞り込みます。このフィルタではプレフィックスを指定します。大文字と小文字は区別されません。
レスポンス
application/jsonリーガルホールドポリシー
リーガルホールドポリシーのリストを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/legal_hold_policies" \
-H "Authorization: Bearer <ACCESS_TOKEN>".NET
BoxCollectionMarkerBased<BoxLegalHoldPolicy> policies = await client.LegalHoldPoliciesManager
.GetListLegalHoldPoliciesAsync();Java
Iterable<BoxLegalHoldPolicy.Info> policies = BoxLegalHoldPolicy.getAll(api);
for (BoxLegalHoldPolicy.Info policyInfo : policies) {
// Do something with the legal hold policy.
}Python
policies = client.get_legal_hold_policies()
for policy in policies:
print(f'Legal Hold Policy "{policy.name}" has ID {policy.id}')Node
client.legalHoldPolicies.getAll({policy_name: 'Important'})
.then(policies => {
/* policies -> {
entries:
[ { type: 'legal_hold_policy',
id: '11111',
policy_name: 'Important Policy 1' },
{ type: 'legal_hold_policy',
id: '22222',
policy_name: 'Important Policy 2' } ],
limit: 100,
order: [ { by: 'policy_name', direction: 'ASC' } ] }
*/
});iOS
let iterator = client.legalHolds.listForEnterprise(policyName: "policy1")
iterator.next { results in
switch results {
case let .success(page):
for policy in page.entries {
print("Legal hold policy \(policy.name)")
}
case let .failure(error):
print(error)
}
}レスポンスの例
{
"entries": [
{
"id": "11446498",
"type": "legal_hold_policy",
"policy_name": "Policy 4",
"description": "Postman created policy",
"status": "active",
"assignment_counts": {
"user": 1,
"folder": 2,
"file": 3,
"file_version": 4
},
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"deleted_at": "2012-12-12T10:53:43-08:00",
"filter_started_at": "2012-12-12T10:53:43-08:00",
"filter_ended_at": "2012-12-12T10:53:43-08:00",
"release_notes": "Example"
}
],
"limit": 1000,
"next_marker": 3000,
"prev_marker": 1000
}