Retrieves a retention policy assignment
643 matches
60 actions
Box
60 actions
- Authorize userGETv1.0.0
- Find file for shared linkGETv1.0.0
- Find folder for shared linkGETv1.0.0
- Find metadata template by instance IDGETv1.0.0
- Find web link for shared linkGETv1.0.0
- Get allowed collaboration domainGETv1.0.0
- Get classification on fileGETv1.0.0
- Get classification on folderGETv1.0.0
- Get collaborationGETv1.0.0
- Get commentGETv1.0.0
- Get device pinGETv1.0.0
- Get file informationGETv1.0.0
- Get file requestGETv1.0.0
- Get files under retentionGETv1.0.0
- Get folder informationGETv1.0.0
- Get groupGETv1.0.0
- Get group membershipGETv1.0.0
- Get legal hold policyGETv1.0.0
- Get legal hold policy assignmentGETv1.0.0
- Get metadata cascade policyGETv1.0.0
- Get metadata instance on fileGETv1.0.0
- Get metadata instance on folderGETv1.0.0
- Get metadata template by IDGETv1.0.0
- Get retention policyGETv1.0.0
- Get retention policy assignmentGETv1.0.0
- Get shared link for fileGETv1.0.0
- Get shared link for folderGETv1.0.0
- Get shield information barrier report by IDGETv1.0.0
- Get trashed fileGETv1.0.0
- Get trashed folderGETv1.0.0
- Get user exempt from collaboration domain restrictionsGETv1.0.0
- Get user invite statusGETv1.0.0
- Get watermark for folderGETv1.0.0
- Get watermark on fileGETv1.0.0
- List all collectionsGETv1.0.0
- List all global metadata templatesGETv1.0.0
- List all legal hold policiesGETv1.0.0
- List all metadata templates for enterpriseGETv1.0.0
- List allowed collaboration domainsGETv1.0.0
- List Box Skill cards on fileGETv1.0.0
- List collection itemsGETv1.0.0
- List enterprise device pinsGETv1.0.0
- List file collaborationsGETv1.0.0
- List file commentsGETv1.0.0
- List folder collaborationsGETv1.0.0
- List folder locksGETv1.0.0
- List group collaborationsGETv1.0.0
- List groups for enterpriseGETv1.0.0
- List members of groupGETv1.0.0
- List metadata cascade policiesGETv1.0.0
- List metadata instances on fileGETv1.0.0
- List metadata instances on folderGETv1.0.0
- List metadata query indicesGETv1.0.0
- List pending collaborationsGETv1.0.0
- List recently accessed itemsGETv1.0.0
- List retention policy assignmentsGETv1.0.0
- List shield information barrier reportsGETv1.0.0
- List shield information barrier segment membersGETv1.0.0
- List tasks on fileGETv1.0.0
- List users exempt from collaboration domain restrictionsGETv1.0.0
Storage/Box
Get retention policy assignment
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
{
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
}
},
"retention_policy_assignment_id": {
"type": "string"
}
},
"required": [
"retention_policy_assignment_id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
{
"type": "object",
"description": "A retention assignment represents a rule specifying\nthe files a retention policy retains.\nAssignments can retain files based on their folder or metadata,\nor hold all files in the enterprise.",
"properties": {
"assigned_at": {
"type": "string",
"format": "date-time",
"description": "When the retention policy assignment object was\ncreated."
},
"assigned_by": {
"type": "object"
},
"assigned_to": {
"type": "object",
"description": "The `type` and `id` of the content that is under\nretention. The `type` can either be `folder`\n`enterprise`, or `metadata_template`.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the folder, enterprise, or metadata template\nthe policy is assigned to."
},
"type": {
"type": "string",
"description": "The type of resource the policy is assigned to.",
"enum": [
"folder",
"enterprise",
"metadata_template"
]
}
}
},
"filter_fields": {
"type": "array",
"description": "An array of field objects. Values are only returned if the `assigned_to`\ntype is `metadata_template`. Otherwise, the array is blank.",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The metadata attribute key id."
},
"value": {
"type": "string",
"description": "The metadata attribute field id. For value, only\nenum and multiselect types are supported."
}
}
}
},
"id": {
"type": "string",
"description": "The unique identifier for a retention policy assignment."
},
"retention_policy": {
"type": "object"
},
"start_date_field": {
"type": "string",
"description": "The date the retention policy assignment begins."
},
"type": {
"type": "string",
"description": "`retention_policy_assignment`",
"enum": [
"retention_policy_assignment"
]
}
}
}