---
title: "ExceptionListResponse"
url: "https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5/schemas/ExceptionListResponse"
---

> Full API specification: https://developers.zinnia.com/apis/case-management-1-0-0/versions/0091226b-6452-4e75-93ce-4bbfe022aad5.md

# ExceptionListResponse

An array containing a list of exception instances, each of which represents an exception raised within a case.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Case Management API
  version: 1.0.0
servers:
  - url: https://dev.api.zinnia.io/
    description: Dev Environment
  - url: https://qa.api.zinnia.io/
    description: QA Environment
  - url: https://uat.api.zinnia.io/
    description: UAT Environment
  - url: https://api.zinnia.io/
    description: PROD Environment
components:
  schemas:
    ExceptionCreateResponse:
      type: object
      properties:
        exceptionId:
          type: string
          description: The unique identifier of the exception.
          example: EX000000000174
        caseId:
          type: string
          description: The unique identifier of the case to which this exception is linked.
          example: CA0000006344
        source:
          type: string
          description: The system or entity that raised the exception.
          example: Zinnia.OnBase
        nmID:
          type: string
          description: The nigo message id.
          example: EM.050
        exceptionType:
          type: string
          description: The exception type of the exception.
          example: Business Exception
        category:
          type: string
          description: The category of the exception, selected from a predefined list.
          example: Agent
        reason:
          type: string
          description: The specific reason for the exception, chosen from a predefined list.
          example: Appointment Status
        detailReason:
          type: string
          description: The detailed reason for the exception.
          example: The agent lacks an appointment in the state where product was sold.s
        exceptionStatus:
          type: string
          description: The current status of the exception.
          enum:
            - NEW
            - UNRESOLVED
            - RESOLVED
            - OVERRIDDEN
          example: NEW
        exceptionAdditionalData:
          type: array
          description: Exception Additional Data
          items:
            $ref: "#/components/schemas/ExceptionAdditionalData"
        createdBy:
          type: string
          description: The user or system that created the exception.
          example: anurag.chaudhary@se2.com
        updatedBy:
          type: string
          description: The user or system that last updated the exception.
          example: anurag.chaudhary@se2.com
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the exception was created, in ISO 8601 format.
        updatedAt:
          type: string
          format: date-time
          description: The timestamp when the exception was last updated, in ISO 8601
            format.
    ExceptionAdditionalData:
      type: object
      description: Additional data related to the Exception.
      properties:
        id:
          type: string
          description: A identifier of Exception Addtional Attribute.
          example: severity
        label:
          type: string
          description: The label for Exception Addtional Attribute.
          example: SEVERITY
        value:
          type: string
          description: The value of Exception Addtional Attribute.
          example: Medium
        dataType:
          type: string
          description: The data type of Exception Addtional Attribute.
          example: STRING
        entityType:
          type: string
          description: The Entity Type of Exception Addtional Attribute.
          example: INCIDENT_ENTITY
        source:
          type: string
          description: The Source of Exception Addtional Attribute.
          example: Zinnia.BPMTransactions
    ExceptionListResponse:
      type: array
      description: An array containing a list of exception instances, each of which
        represents an exception raised within a case.
      items:
        $ref: "#/components/schemas/ExceptionCreateResponse"
```