Get retention for file

get
https://api.box.com/2.0
/file_version_retentions/:file_version_retention_id

Returns information about a file version retention.

Request

application/json

Path Parameters

stringin pathrequired
3424234

The ID of the file version retention

Response

Returns a file version retention object.

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/file_version_retentions/3424234 \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxFileVersionRetention retention = await client.RetentionPoliciesManager
    .GetFileVersionRetentionAsync("55555");
Java
BoxFileVersionRetention policy = new BoxFileVersionRetention(api, id);
BoxFileVersionRetention.Info policyInfo = policy.getInfo();
Python
retention_info = client.file_version_retention(retention_id='12345').get()
print('The file version retention ID is {0} and the data time applied at is {1}'.format(retention.id, retention.applied_at))
Node
client.retentionPolicies.getFileVersionRetention('55555')
	.then(retention => {
		/* retention -> {
			type: 'file_version_retention',
			id: '55555',
			applied_at: '2015-08-06T22:02:24-07:00',
			disposition_at: '2016-08-06T21:45:28-07:00',
			winning_retention_policy: 
			{ type: 'retention_policy',
				id: '11111',
				policy_name: 'Tax Documents' },
			file_version: 
			{ type: 'file_version',
				id: '44444',
				sha1: '4262d6250b0e6f440dca43a2337bd4621bad9136' },
			file: { type: 'file', id: '33333', etag: '2' } }
		*/
	});

Response Example

{
  "id": 11446498,
  "type": "file_version_retention",
  "file_version": {
    "id": 12345,
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "file": {
    "id": 12345,
    "etag": 1,
    "type": "file",
    "sequence_id": 3,
    "name": "Contract.pdf"
  },
  "applied_at": "2012-12-12T10:53:43-08:00",
  "disposition_at": "2012-12-12T10:53:43-08:00",
  "winning_retention_policy": {
    "id": 12345,
    "type": "file_version",
    "policy_name": "Some Policy Name",
    "retention_length": 0,
    "disposition_action": "permanently_delete"
  }
}