Retention policy assignment

The retention policy assignment endpoint provides a way for admins to apply a retention policy on a per-folder basis, or place a blanket policy over the entire enterprise.

id string

example11446498

The unique identifier for this retention policy assignment

type string

exampleretention_policy_assignment

Value is always retention_policy_assignment

assigned_at string / date-time

example2012-12-12T10:53:43-08:00

When the retention policy assignment object was created

assigned_byUser (Mini) object

A mini user object representing the user that created the retention policy assignment object

assigned_to object

The type and id of the content that is under retention. The type can either be folder or enterprise.

assigned_to.id string

example11446498

The unique identifier for this object

assigned_to.type string

examplefile

The type for this object

retention_policyRetention policy (Mini) object

A mini retention policy object representing the retention policy that has been assigned to this content

Response Example

{
  "id": 11446498,
  "type": "retention_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": 11446498,
    "type": "file"
  },
  "retention_policy": {
    "id": 12345,
    "type": "file_version",
    "disposition_action": "permanently_delete",
    "policy_name": "Some Policy Name",
    "retention_length": 365
  }
}