ストレージポリシーのリストを取得
企業のすべてのストレージポリシーを取得します。このエンドポイントにアクセスできるのは、プライマリ管理者のみです。ユーザーは、このリクエストを認証するためにアカウントのトークンを生成する必要があります。
リクエスト
bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のカンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
integer / int64クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/storage_policies" \
-H "Authorization: Bearer <ACCESS_TOKEN>".NET
BoxCollectionMarkerBased<BoxStoragePolicy> policies = await client.StoragePoliciesManager
.GetListStoragePoliciesAsync();Java
Iterable<BoxStoragePolicy.Info> storagePolicies = BoxStoragePolicy.getAll(api);
for (BoxStoragePolicy.Info storagePolicyInfo : storagePolicies) {
//Do something with the storage policy.
}Python
storage_policies = client.get_storage_policies(limit=100)
for storage_policy in storage_policies:
print(f'The storage policy id is {storage_policy.id} and name is {storage_policy.name}')Node
client.storagePolicies.getAll()
.then(policies => {
/* policies -> {
next_marker: null,
limit: 1000,
entries:
[ { type: 'storage_policy', id: '42', name: 'Montreal / Dublin' },
{ type: 'storage_policy', id: '126', name: 'Frankfurt / Dublin' },
{ type: 'storage_policy', id: '162', name: 'US' } ] }
*/
});iOS
let iterator = client.storagePolicies.listForEnterprise()
iterator.next { results in
switch results {
case let .success(page):
for policy in page.entries {
print("Storage policy \(policy.id)")
}
case let .failure(error):
print(error)
}
}レスポンスの例
{
"entries": [
{
"id": "11446498",
"type": "storage_policy",
"name": "Montreal / Dublin"
}
],
"limit": 1000,
"next_marker": 3000,
"prev_marker": 1000
}