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

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

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

場合によっては、代わりに以前のファイルバージョンを取得できます。このような場合は、代わりに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

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

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

integer / int64クエリ内省略可能
10001000

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

レスポンス

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

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

get
リーガルホールドポリシー割り当てに関する現在のファイルバージョンのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

レスポンスの例

{
  "entries": [
    {
      "id": 11446498,
      "type": "file_version_legal_hold",
      "file_version": {
        "id": 12345,
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "file": {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": 12345,
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        }
      },
      "legal_hold_policy_assignments": [
        {
          "id": 11446498,
          "type": "legal_hold_policy_assignment",
          "legal_hold_policy": {
            "id": 11446498,
            "type": "legal_hold_policy"
          },
          "assigned_to": {
            "id": 12345,
            "etag": 1,
            "type": "file",
            "sequence_id": 3,
            "name": "Contract.pdf",
            "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
            "file_version": {
              "id": 12345,
              "type": "file_version",
              "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
            },
            "description": "Contract for Q1 renewal",
            "size": 629644,
            "path_collection": {
              "total_count": 1,
              "entries": [
                {
                  "id": 12345,
                  "etag": 1,
                  "type": "folder",
                  "sequence_id": 3,
                  "name": "Contracts"
                }
              ]
            },
            "created_at": "2012-12-12T10:53:43-08:00",
            "modified_at": "2012-12-12T10:53:43-08:00",
            "trashed_at": "2012-12-12T10:53:43-08:00",
            "purged_at": "2012-12-12T10:53:43-08:00",
            "content_created_at": "2012-12-12T10:53:43-08:00",
            "content_modified_at": "2012-12-12T10:53:43-08:00",
            "created_by": {
              "id": 11446498,
              "type": "user",
              "name": "Aaron Levie",
              "login": "ceo@example.com"
            },
            "modified_by": {
              "id": 11446498,
              "type": "user",
              "name": "Aaron Levie",
              "login": "ceo@example.com"
            },
            "owned_by": {
              "id": 11446498,
              "type": "user",
              "name": "Aaron Levie",
              "login": "ceo@example.com"
            },
            "shared_link": {
              "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
              "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
              "vanity_url": "https://acme.app.box.com/v/my_url/",
              "access": "open",
              "effective_access": "company",
              "effective_permission": "can_download",
              "unshared_at": "2018-04-13T13:53:23-07:00",
              "is_password_enabled": true,
              "permissions": {
                "can_download": true,
                "can_preview": true
              },
              "download_count": 3,
              "preview_count": 3
            },
            "parent": {
              "id": 12345,
              "etag": 1,
              "type": "folder",
              "sequence_id": 3,
              "name": "Contracts"
            },
            "item_status": "active",
            "allowed_invitee_roles": [
              "editor"
            ],
            "is_externally_owned": true,
            "has_collaborations": true
          },
          "assigned_by": {
            "id": 11446498,
            "type": "user",
            "name": "Aaron Levie",
            "login": "ceo@example.com"
          },
          "assigned_at": "2012-12-12T10:53:43-08:00",
          "deleted_at": "2012-12-12T10:53:43-08:00"
        }
      ],
      "deleted_at": "2012-12-12T10:53:43-08:00"
    }
  ],
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000
}