Box Developer Documentation
Log in
Latest version

Get file version legal hold

get
https://api.box.com/2.0
/file_version_legal_holds/:file_version_legal_hold_id

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

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
2348213

The ID of the file version legal hold

Response

application/jsonFile version legal hold

Returns the legal hold policy assignments for the file version.

application/jsonClient error

An unexpected client error.

get
Get file version legal hold
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/file_version_legal_holds/2348213" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.fileVersionLegalHolds.getFileVersionLegalHoldById(
  fileVersionLegalHoldId,
);
Python Gen
client.file_version_legal_holds.get_file_version_legal_hold_by_id(
    file_version_legal_hold_id
)
.NET Gen
await client.FileVersionLegalHolds.GetFileVersionLegalHoldByIdAsync(fileVersionLegalHoldId: fileVersionLegalHoldId);
Java
BoxFileVersionLegalHold hold = new BoxFileVersionLegalHold(api, id);
hold.getInfo("file");
Python
file_version_legal_hold_id = '55555'
legal_hold = client.legal_hold(file_version_legal_hold_id).get()
print(f'Version {legal_hold.file_version.id} of file {legal_hold.file.id} is held by {len(legal_hold.legal_hold_policy_assignments)} assignment(s)')
.NET
BoxFileVersionLegalHold hold = await client.LegalHoldPoliciesManager
    .GetFileVersionLegalHoldAsync("55555");
Node
client.legalHoldPolicies.getFileVersionLegalHold('55555')
	.then(fileVersionHold => {
		/* fileVersionHold -> {
			type: 'legal_hold',
			id: '55555',
			file_version: { type: 'file_version', id: '123456789' },
			file: { type: 'file', id: '66666', etag: '1' },
			legal_hold_policy_assignments: 
			[ { type: 'legal_hold_policy_assignment', id: '22222' },
				{ type: 'legal_hold_policy_assignment', id: '33333' } ],
			deleted_at: null }
		*/
	});
iOS
client.legalHolds.getFileVersionPolicy(legalHoldId: "22222") { (result: Result<FileVersionLegalHold, BoxSDKError>) in
    guard case let .success(legalHold) = result else {
        print("Error getting file version legal hold")
        return
    }
    print("File version legal hold ID is \(legalHold.id)")
}

Response Example

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