Retention policy assignment

API version 2024.0 A retention assignment represents a rule specifying the files a retention policy retains. Assignments can retain files based on their folder or metadata, or hold all files in the enterprise.

string

example: 11446498The unique identifier for a retention policy assignment.

type

string

example: retention_policy_assignmentThe value will always be retention_policy_assignment.Value is always retention_policy_assignment

assigned_at

string(date-time)

example: 2012-12-12T10:53:43-08:00When the retention policy assignment object was created.

assigned_by

User (Mini)object

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

assigned_to

object

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

Show child attributes

string

example: a983f69f-e85f-4ph4-9f46-4afdf9c1af65The ID of the folder, enterprise, or metadata template the policy is assigned to. Set to null or omit when type is set to enterprise.

type

string

example: metadata_templateThe type of resource the policy is assigned to.Value is one of folder,enterprise,metadata_template

filter_fields

object[]

An array of field objects. Values are only returned if the assigned_to type is metadata_template. Otherwise, the array is blank.

Show child attributes

field

string

example: a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4The metadata attribute key id.

value

string

example: 0c27b756-0p87-4fe0-a43a-59fb661ccc4eThe metadata attribute field id. For value, only enum and multiselect types are supported.

retention_policy

Retention policy (Mini)object

A mini representation of a retention policy object that has been assigned to the content.

start_date_field

string

example: upload_dateThe date the retention policy assignment begins. If the assigned_to type is metadata_template, this field can be a date field’s metadata attribute key id.

{
  "id": "11446498",
  "type": "retention_policy_assignment",
  "assigned_at": "2012-12-12T10:53:43-08:00",
  "assigned_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "assigned_to": {
    "id": "a983f69f-e85f-4ph4-9f46-4afdf9c1af65",
    "type": "metadata_template"
  },
  "filter_fields": [
    {
      "field": "a0f4ee4e-1dc1-4h90-a8a9-aef55fc681d4",
      "value": "0c27b756-0p87-4fe0-a43a-59fb661ccc4e"
    }
  ],
  "retention_policy": {
    "id": "12345",
    "type": "retention_policy",
    "disposition_action": "permanently_delete",
    "policy_name": "Some Policy Name",
    "retention_length": "365"
  },
  "start_date_field": "upload_date"
}