RetentionHoldRead

Fields

One hold; state (live / expired / released) is computed by the service for now.

13 fields

entity_id

string (uuid) or null

entity_label

string or null

entity_type · required

string

expires_at

string (date-time) or null

id · required

string (uuid)

placed_at · required

string (date-time)

placed_by_name

string or null

project_id · required

string (uuid)

reason · required

string

release_reason

string or null

released_at

string (date-time) or null

released_by_name

string or null

state · required

string

Raw schema (JSON)

{
  "description": "One hold; ``state`` (live / expired / released) is computed by the service for ``now``.",
  "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"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "placed_at": {
      "format": "date-time",
      "title": "Placed At",
      "type": "string"
    },
    "placed_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Placed By Name"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "reason": {
      "title": "Reason",
      "type": "string"
    },
    "release_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Release Reason"
    },
    "released_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Released At"
    },
    "released_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Released By Name"
    },
    "state": {
      "title": "State",
      "type": "string"
    }
  },
  "required": [
    "id",
    "project_id",
    "entity_type",
    "reason",
    "state",
    "placed_at"
  ],
  "title": "RetentionHoldRead",
  "type": "object"
}

Used by endpoints

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

• POST /api/v1/projects/{project_id}/retention-holds — Place Retention Hold
• POST /api/v1/projects/{project_id}/retention-holds/{hold_id}/release — Release Retention Hold
• GET /api/v1/projects/{project_id}/retention-holds — List Retention Holds

Used by schemas

• RetentionHoldListResponse

More details

• Specification: OpenAPI JSON