日本時間5月16日のContent Cloud Summitで、カスタムアプリにBox AI APIを活用する方法を紹介します。

詳細を表示

List files with current file versions for legal hold policy assignment

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

Get a list of files with current file versions for a legal hold assignment.

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

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

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

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

クエリパラメータ

string arrayクエリ内省略可能
id,type,name

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

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

integer (int64)クエリ内省略可能
10001000

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

レスポンス

application/jsonFiles on hold

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

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

get
List files with current file versions for legal hold policy assignment
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

レスポンスの例

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