Box · Schema

File version retention

A retention policy blocks permanent deletion of content for a specified amount of time. Admins can apply policies to specified folders, or an entire enterprise. A file version retention is a record for a retained file version. To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console. For more information about retention policies, please visit our help documentation

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for this file version retention.
type string `file_version_retention`
file_version object
file object
applied_at string When this file version retention object was created
disposition_at string When the retention expires on this file version retention
winning_retention_policy object
View JSON Schema on GitHub

JSON Schema

box-fileversionretention-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FileVersionRetention",
  "title": "File version retention",
  "type": "object",
  "x-box-resource-id": "file_version_retention",
  "x-box-tag": "file_version_retentions",
  "description": "A retention policy blocks permanent deletion of content\nfor a specified amount of time. Admins can apply policies to\nspecified folders, or an entire enterprise. A file version retention\nis a  record for a retained file version. To use this feature,\nyou must  have the manage retention policies scope enabled for your\nAPI key via  your application management console. For more information\nabout retention policies, please visit our help documentation",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this file version retention.",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`file_version_retention`",
      "example": "file_version_retention",
      "enum": [
        "file_version_retention"
      ]
    },
    "file_version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileVersion--Mini"
        },
        {
          "description": "The file version this file version retention was\napplied to"
        }
      ]
    },
    "file": {
      "allOf": [
        {
          "$ref": "#/components/schemas/File--Mini"
        },
        {
          "description": "The file this file version retention was applied to"
        }
      ]
    },
    "applied_at": {
      "type": "string",
      "format": "date-time",
      "description": "When this file version retention object was\ncreated",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "disposition_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the retention expires on this file\nversion retention",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "winning_retention_policy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RetentionPolicy--Mini"
        },
        {
          "description": "The winning retention policy applied to this file\nversion retention. A file version can have multiple\nretention policies applied."
        }
      ]
    }
  }
}