v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

File version retentions

Get retention on file

Returns information about a file version retention.

Note: File retention API is now deprecated. To get information about files and file versions under retention, see files under retention or file versions under retention endpoints.

get/file_version_retentions/{file_version_retention_id}

Path parameters

file_version_retention_idstring required

The ID of the file version retention.

Response

Returns a file version retention object.

idstring

The unique identifier for this file version retention.

type'file_version_retention'

The value will always be file_version_retention.

applied_atstring date-time

When this file version retention object was created.

disposition_atstring date-time

When the retention expires on this file version retention.

Example response

{
  "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",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  },
  "applied_at": "2012-12-12T10:53:43-08:00",
  "disposition_at": "2012-12-12T10:53:43-08:00",
  "winning_retention_policy": {
    "id": "12345",
    "type": "retention_policy",
    "policy_name": "Some Policy Name",
    "retention_length": "365",
    "disposition_action": "permanently_delete"
  }
}