BulkIdResponseDto

Endpoints · All schemas

Field	Required	Description
error	No	See definition below
errorMessage	No	string
id	Yes	ID
success	Yes	Whether operation succeeded

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: BulkIdErrorReason

{
  "properties": {
    "error": {
      "$ref": "#/components/schemas/BulkIdErrorReason"
    },
    "errorMessage": {
      "type": "string"
    },
    "id": {
      "description": "ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "success": {
      "description": "Whether operation succeeded",
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "success"
  ],
  "type": "object"
}