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

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

# ExceptionInstance

## 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:
    AdditionalDataInstance:
      type: object
      additionalProperties:
        type: string
    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
    ExceptionInstance:
      type: object
      properties:
        id:
          type: string
          description: Unique Identifier for Exception Instance
        status:
          type: string
          enum:
            - NEW
            - RESOLVED
          description: Status of Exception Instance
        exceptionRefId:
          type: string
          description: The exceptionRefId of the exception.
          example: NB.EM.068
        exceptionType:
          type: string
          description: The exceptionType of the exception.
          example: Business Exception
        category:
          type: string
          description: Category of Exception
        reason:
          type: string
          description: Short description of Exception
        detailedReason:
          type: string
          description: Detailed description of Exception
        updatedAt:
          type: string
          description: Last updated timestamp of Exception
        taskIdList:
          type: array
          items:
            type: string
          uniqueItems: true
          description: List of Task Identifier associated with Exception Instance
        additionalData:
          $ref: "#/components/schemas/AdditionalDataInstance"
        exceptionAdditionalData:
          type: array
          description: Exception Additional Data
          items:
            $ref: "#/components/schemas/ExceptionAdditionalData"
        eventRef:
          type: array
          items:
            type: string
          description: List of Events associated with Exception Instance
```
