cURL

curl --request GET \
  --url https://api.box.com/2.0/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold \
  --header 'Authorization: Bearer <token>'

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "12345",
      "type": "file",
      "etag": "1",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ]
}

エンドポイント

リーガルホールドポリシー割り当てに関する現在のファイルバージョンを含むファイルのリストを取得

リーガルホールド割り当てに関する現在のファイルバージョンを含むファイルのリストを取得します。

場合によっては、代わりに以前のファイルバージョンを取得できます。このような場合は、代わりにGET /legal_hold_policy_assignments/:id/file_versions_on_hold APIを使用すると、このリーガルホールドポリシー割り当てに関するファイルの以前のバージョンが返されます。

進行中の再構築作業により、このAPIでは、このポリシーID用に保持されているすべてのファイルバージョンが返されない場合があります。代わりに、このAPIで返されるのは、新しく開発されたアーキテクチャで保持されている最新のファイルバージョンのみです。GET /file_version_legal_holds APIを使用すると、従来のアーキテクチャ内で保持されているファイルの現在のバージョンと過去のバージョンを取得できます。

このエンドポイントは、カストディアンがHubでコラボレーションしているためにリーガルホールドが設定されているコンテンツを返すことをサポートしていません。

GET /legal_hold_policy_assignments?policy_id={id} APIを使用すると、指定したポリシーIDのポリシー割り当てのリストを確認できます。

GET

legal_hold_policy_assignments

{legal_hold_policy_assignment_id}

files_on_hold

cURL

curl --request GET \
  --url https://api.box.com/2.0/legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold \
  --header 'Authorization: Bearer <token>'

{
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
  "entries": [
    {
      "id": "12345",
      "type": "file",
      "etag": "1",
      "sequence_id": "3",
      "name": "Contract.pdf",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": "12345",
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      }
    }
  ]
}

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization

string

header

必須

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

パスパラメータ

legal_hold_policy_assignment_id

string

必須

リーガルホールドポリシー割り当てのID。

クエリパラメータ

marker

string

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

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

limit

integer<int64>

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

必須範囲: x <= 1000

fields

string[]

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

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

レスポンス

特定のリーガルホールドポリシー割り当てに関する、リーガルホールドで保持されている現在のファイルバージョンのリストを返します。

リーガルホールドポリシー割り当てにより、リーガルホールドが設定されているファイルのリスト。

limit

integer<int64>

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

例:

1000

next_marker

string | null

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

例:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

prev_marker

string | null

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

例:

"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"

entries

ファイル (Mini) · object[]

ファイルのリスト。

表示子属性

リーガルホールドポリシー割り当てに関する以前のファイルバージョンのリストを取得

リーガルホールドポリシーを割り当て

⌘I