Box · Schema

Legal hold policy assignment (Base)

Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the File-Versions that belong to the Assignment's 'apply-to' entity.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
id	string	The unique identifier for this legal hold assignment
type	string	`legal_hold_policy_assignment`

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LegalHoldPolicyAssignment--Base",
  "title": "Legal hold policy assignment (Base)",
  "type": "object",
  "x-box-resource-id": "legal_hold_policy_assignment--base",
  "x-box-sanitized": true,
  "x-box-tag": "legal_hold_policy_assignments",
  "x-box-variants": [
    "base",
    "standard"
  ],
  "x-box-variant": "base",
  "description": "Legal Hold Assignments are used to assign Legal Hold\nPolicies to Users, Folders, Files, or File Versions.\n\nCreating a Legal Hold Assignment puts a hold\non the File-Versions that belong to the Assignment's\n'apply-to' entity.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this legal hold assignment",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`legal_hold_policy_assignment`",
      "example": "legal_hold_policy_assignment",
      "enum": [
        "legal_hold_policy_assignment"
      ]
    }
  }
}