Box · Schema

File version legal hold

File-Version-Legal-Hold is an entity representing all holds on a File Version.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for this file version legal hold
type string `file_version_legal_hold`
file_version object
file object
legal_hold_policy_assignments array List of assignments contributing to this Hold.
deleted_at string Time that this File-Version-Legal-Hold was deleted.
View JSON Schema on GitHub

JSON Schema

box-fileversionlegalhold-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FileVersionLegalHold",
  "title": "File version legal hold",
  "type": "object",
  "x-box-resource-id": "file_version_legal_hold",
  "x-box-tag": "file_version_legal_holds",
  "description": "File-Version-Legal-Hold is an entity representing all\nholds on a File Version.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this file version legal hold",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`file_version_legal_hold`",
      "example": "file_version_legal_hold",
      "enum": [
        "file_version_legal_hold"
      ]
    },
    "file_version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FileVersion--Mini"
        },
        {
          "description": "The file version that is held"
        }
      ]
    },
    "file": {
      "allOf": [
        {
          "$ref": "#/components/schemas/File--Mini"
        },
        {
          "description": "The file for the file version held.\nNote that there is no guarantee that the current\nversion of this file is held."
        }
      ]
    },
    "legal_hold_policy_assignments": {
      "description": "List of assignments contributing to this Hold.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LegalHoldPolicyAssignment"
      }
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "description": "Time that this File-Version-Legal-Hold was\ndeleted.",
      "example": "2012-12-12T10:53:43-08:00"
    }
  }
}