HoldRefRead

Fields

A live retention hold as it appears inside another answer.

6 fields

entity_id

string (uuid) or null

entity_label

string or null

entity_type · required

string

expires_at

string (date-time) or null

hold_id · required

string (uuid)

reason · required

string

Raw schema (JSON)

{
  "description": "A live retention hold as it appears inside another answer.",
  "properties": {
    "entity_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Entity Id"
    },
    "entity_label": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Entity Label"
    },
    "entity_type": {
      "title": "Entity Type",
      "type": "string"
    },
    "expires_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Expires At"
    },
    "hold_id": {
      "format": "uuid",
      "title": "Hold Id",
      "type": "string"
    },
    "reason": {
      "title": "Reason",
      "type": "string"
    }
  },
  "required": [
    "hold_id",
    "entity_type",
    "reason"
  ],
  "title": "HoldRefRead",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/releases/{release_id}/compliance-pack — Generate Compliance Pack
• GET /api/v1/releases/{release_id}/compliance-packs — List Compliance Packs

Used by schemas

• CompliancePackRead

More details

• Specification: OpenAPI JSON