Get legal hold policy assignment

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

Retrieve a legal hold policy assignment.

Request

Bearer [ACCESS_TOKEN]
application/json

Path Parameters

Response

Returns a legal hold policy object.

application/jsonClient error

An unexpected client error.

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

Request Example

cURL
curl -X GET https://api.box.com/2.0/legal_hold_policy_assignments/753465 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
.NET
BoxLegalHoldPolicyAssignment assignment = await client.LegalHoldPoliciesManager
    .GetAssignmentAsync(assignmentId: "22222");
Java
BoxLegalHoldAssignment assignment = new BoxLegalHoldAssignment(api, id);
BoxLegalHoldAssignment.Info info = assignment.getInfo("assigned_by");
Python
assignment_id = '98765'
assignment = client.legal_hold_policy_assignment(assignment_id).get()
print('Policy {0} is assigned to {1} {2}'.format(
    assignment.legal_hold_policy.id,
    assignment.assigned_to.type,
    assignment.assigned_to.id,
))
Node
client.legalHoldPolicies.getAssignment('22222')
	.then(assignment => {
		/* assignment -> {
			type: 'legal_hold_policy_assignment',
			id: '22222',
			legal_hold_policy: 
			{ type: 'legal_hold_policy',
				id: '11111',
				policy_name: 'IRS Audit' },
			assigned_to: { type: 'user', id: '33333' },
			assigned_by: 
			{ type: 'user',
				id: '11111',
				name: 'Example User',
				login: 'user@example.com' },
			assigned_at: '2016-05-18T10:32:19-07:00',
			deleted_at: null }
		*/
	});
iOS
client.legalHolds.getPolicyAssignment(assignmentId: "22222", fields: ["assigned_at"]) { (result: Result<LegalHoldPolicyAssignment, BoxSDKError>) in
    guard case let .success(assignment) = result else {
        print("Error getting policy assignment info")
        return
    }
    print("Legal hold policy assignment \(assignmnent.id) was created at \(assignment.assignedAt)")
}

Response Example

{
  "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": {
    "id": 12345,
    "type": "file",
    "allowed_invitee_roles": [
      "editor"
    ],
    "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",
    "etag": 1,
    "file_version": {
      "id": 12345,
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "has_collaborations": true,
    "is_externally_owned": true,
    "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"
    },
    "name": "Contract.pdf",
    "owned_by": {
      "id": 11446498,
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "parent": {
      "id": 12345,
      "type": "folder",
      "etag": 1,
      "name": "Contracts",
      "sequence_id": 3
    },
    "path_collection": {
      "entries": [
        {
          "id": 12345,
          "etag": 1,
          "type": "folder",
          "sequence_id": 3,
          "name": "Contracts"
        }
      ],
      "total_count": 1
    },
    "purged_at": "2012-12-12T10:53:43-08:00",
    "sequence_id": 3,
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "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_preview": true
      },
      "preview_count": 3,
      "unshared_at": "2018-04-13T13:53:23-07:00",
      "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
      "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"
  }
}