Get file version legal hold | Sample

1 parameter

file_version_legal_hold_idstringrequired

The ID of the file version legal hold.

2 status codes

200Returns the legal hold policy assignments for the file version.

idstringoptional

The unique identifier for this file version legal hold.

typestringoptional

The value will always be `file_version_legal_hold`.

Allowed:file_version_legal_hold

file_versionobjectoptional

fileobjectoptional

legal_hold_policy_assignmentsarray<LegalHoldPolicyAssignment>optional

List of assignments contributing to this Hold.

deleted_atstringoptional

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

defaultAn unexpected client error.

typestringoptional

The value will always be `error`.

Allowed:error

statusintegeroptional

The HTTP status of the response.

codestringoptional

A Box-specific error code.

Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed

messagestringoptional

A short message describing the error.

context_infoobjectoptional

A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.

help_urlstringoptional

A URL that links to more information about why this error occurred.

request_idstringoptional

A unique identifier for this response, which can be used when contacting Box support.

Error handling

Any other status is an error: An unexpected client error.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.fileVersionLegalHolds.get({ fileVersionLegalHoldId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "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": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": null,
      "type": null,
      "sha1": null
    }
  },
  "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": null,
        "type": null,
        "name": null,
        "login": null
      },
      "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"
}

Request

Response

Errors