Box · Schema

Legal hold policy assignment

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
View JSON Schema on GitHub

JSON Schema

box-legalholdpolicyassignment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LegalHoldPolicyAssignment",
  "title": "Legal hold policy assignment",
  "type": "object",
  "x-box-resource-id": "legal_hold_policy_assignment",
  "x-box-tag": "legal_hold_policy_assignments",
  "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.",
  "allOf": [
    {
      "$ref": "#/components/schemas/LegalHoldPolicyAssignment--Base"
    },
    {
      "properties": {
        "legal_hold_policy": {
          "allOf": [
            {
              "$ref": "#/components/schemas/LegalHoldPolicy--Mini"
            },
            {
              "description": "The policy that the legal hold policy assignment\nis part of"
            }
          ]
        },
        "assigned_to": {
          "allOf": [
            {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/File"
                },
                {
                  "$ref": "#/components/schemas/Folder"
                },
                {
                  "$ref": "#/components/schemas/WebLink"
                }
              ]
            },
            {
              "description": "The item that the the legal hold policy\nis assigned to. Includes type and ID."
            }
          ]
        },
        "assigned_by": {
          "allOf": [
            {
              "$ref": "#/components/schemas/User--Mini"
            },
            {
              "description": "The user who created the legal hold policy\nassignment"
            }
          ]
        },
        "assigned_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the legal hold policy assignment object was\ncreated",
          "example": "2012-12-12T10:53:43-08:00"
        },
        "deleted_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the assignment release request was sent.\n(Because it can take time for an assignment to fully\ndelete, this isn't quite the same time that the\nassignment is fully deleted). If null, Assignment\nwas not deleted.",
          "example": "2012-12-12T10:53:43-08:00"
        }
      }
    }
  ]
}