v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
File version legal holds

Get file version legal hold

Retrieves information about the legal hold policies assigned to a file version.

get/file_version_legal_holds/{file_version_legal_hold_id}

Path parameters

file_version_legal_hold_idstring required

The ID of the file version legal hold.

Response

Returns the legal hold policy assignments for the file version.

idstring

The unique identifier for this file version legal hold.

type'file_version_legal_hold'

The value will always be file_version_legal_hold.

deleted_atstring date-time

Time that this File-Version-Legal-Hold was deleted.

Example response

{
  "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": {
        "type": "folder",
        "id": "6564564"
      },
      "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"
}