メインコンテンツへスキップ
GET
/
legal_hold_policies
cURL
curl -i -X GET "https://api.box.com/2.0/legal_hold_policies" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "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"
    }
  ]
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
policy_name
string

名前がこの検索語句で始まるポリシーのみに結果を絞り込みます。このフィルタではプレフィックスを指定します。大文字と小文字は区別されません。

​
fields
string[]

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

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

​
marker
string

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

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

​
limit
integer<int64>

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

必須範囲: x <= 1000

Response

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

リーガルホールドポリシーのリスト。 マーカーベースのページネーションについて説明しているAPIレスポンスの部分。

​
limit
integer<int64>

これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。

Example:

1000

​
next_marker
string | null

次の検索結果ページの開始場所のマーカー。

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

​
prev_marker
string | null

前の検索結果ページの開始場所のマーカー。

Example:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

​
entries
リーガルホールドポリシー · object[]

リーガルホールドポリシーのリスト。