parentKeystring
The key of the parent entity whose Reference Data are to be retrieved.
Fetch List of reference data by Type and Parent Key
Fetch List of reference data by Type and Parent Key
get
Query Parameters
Path Parameters
typestringrequired
The type of reference data to retrieve.
Response
application/json
Response
application/json
A list of reference data models.
ReferenceResponseModel
typestring
The type of the reference data.
parentKeystring
The key of the parent entity.
keystring
The key of the reference data.
valuestring
The value associated with the reference data.
get/case/v1/refdata/{type}
Authentication
Path Parameters
Query Parameters
application/json
Exception Instance (Exception Management)
Create Exception
Creates a new exception for the specified case instance.
post
Path Parameters
caseIdstringrequired
Unique identifier of the case instance for which the exception is being created.
Example:CA0000006344
Body
application/json
Body
application/json
ExceptionCreateRequest
sourcestring
The system that raised the exception.
Example:Zinnia.OnBase
nmIDstring
The nigo message id.
Example:EM.050
Response
application/json
Response
application/json
Successful operation and creates a new resource
ExceptionCreateResponse
exceptionIdstring
The unique identifier of the exception.
Example:EX000000000174
caseIdstring
The unique identifier of the case to which this exception is linked.
Example:CA0000006344
sourcestring
The system or entity that raised the exception.
Example:Zinnia.OnBase
nmIDstring
The nigo message id.
Example:EM.050
exceptionTypestring
The exception type of the exception.
Example:Business Exception
categorystring
The category of the exception, selected from a predefined list.
Example:Agent
reasonstring
The specific reason for the exception, chosen from a predefined list.
Example:Appointment Status
detailReasonstring
The detailed reason for the exception.
Example:The agent lacks an appointment in the state where product was sold.s
exceptionStatusstring
The current status of the exception.
Allowed values:NEWUNRESOLVEDRESOLVEDOVERRIDDEN
Example:NEW
exceptionAdditionalDataarray[object]
Additional data related to the Exception.
Show Child Parameters
createdBystring
The user or system that created the exception.
Example:anurag.chaudhary@se2.com
updatedBystring
The user or system that last updated the exception.
Example:anurag.chaudhary@se2.com
createdAtstring(date-time)
The timestamp when the exception was created, in ISO 8601 format.
updatedAtstring(date-time)
The timestamp when the exception was last updated, in ISO 8601 format.
post/case/v1/exceptions/cases/{caseId}
Authentication
Path Parameters
Body
{}
application/json
Retrieve List of Exceptions
Retrieves a list of exception instances associated with the specified case.
get
Path Parameters
caseIdstringrequired
Unique identifier of the case instance for which the exception is being created
Example:CA0000006344
Response
application/json
Response
application/json
Successful operation
ExceptionListResponse
An array containing a list of exception instances, each of which represents an exception raised within a case.
exceptionIdstring
The unique identifier of the exception.
Example:EX000000000174
caseIdstring
The unique identifier of the case to which this exception is linked.
Example:CA0000006344
sourcestring
The system or entity that raised the exception.
Example:Zinnia.OnBase
nmIDstring
The nigo message id.
Example:EM.050
exceptionTypestring
The exception type of the exception.
Example:Business Exception
categorystring
The category of the exception, selected from a predefined list.
Example:Agent
reasonstring
The specific reason for the exception, chosen from a predefined list.
Example:Appointment Status
detailReasonstring
The detailed reason for the exception.
Example:The agent lacks an appointment in the state where product was sold.s
exceptionStatusstring
The current status of the exception.
Allowed values:NEWUNRESOLVEDRESOLVEDOVERRIDDEN
Example:NEW
exceptionAdditionalDataarray[object]
Additional data related to the Exception.
Show Child Parameters
createdBystring
The user or system that created the exception.
Example:anurag.chaudhary@se2.com
updatedBystring
The user or system that last updated the exception.
Example:anurag.chaudhary@se2.com
createdAtstring(date-time)
The timestamp when the exception was created, in ISO 8601 format.
updatedAtstring(date-time)
The timestamp when the exception was last updated, in ISO 8601 format.
get/case/v1/exceptions/cases/{caseId}
Authentication
Path Parameters
application/json
Update an Existing Exception
Updates details of a specific exception instance within a given case.
patch
Path Parameters
caseIdstringrequired
Unique identifier of the case instance to which the exception belongs.
Example:CA0000006344
exceptionIdstringrequired
Unique identifier of the exception being updated.
Example:EX000000000174
Body
application/json
Body
application/json
ExceptionPatchRequest
sourcestring
The system that raised the exception.
Example:Zinnia.OnBase
exceptionStatusstring
The current status of the exception.
Example:NEW
Response
application/json
Response
application/json
Successful operation
ExceptionCreateResponse
exceptionIdstring
The unique identifier of the exception.
Example:EX000000000174
caseIdstring
The unique identifier of the case to which this exception is linked.
Example:CA0000006344
sourcestring
The system or entity that raised the exception.
Example:Zinnia.OnBase
nmIDstring
The nigo message id.
Example:EM.050
exceptionTypestring
The exception type of the exception.
Example:Business Exception
categorystring
The category of the exception, selected from a predefined list.
Example:Agent
reasonstring
The specific reason for the exception, chosen from a predefined list.
Example:Appointment Status
detailReasonstring
The detailed reason for the exception.
Example:The agent lacks an appointment in the state where product was sold.s
exceptionStatusstring
The current status of the exception.
Allowed values:NEWUNRESOLVEDRESOLVEDOVERRIDDEN
Example:NEW
exceptionAdditionalDataarray[object]
Additional data related to the Exception.
Show Child Parameters
createdBystring
The user or system that created the exception.
Example:anurag.chaudhary@se2.com
updatedBystring
The user or system that last updated the exception.
Example:anurag.chaudhary@se2.com
createdAtstring(date-time)
The timestamp when the exception was created, in ISO 8601 format.
updatedAtstring(date-time)
The timestamp when the exception was last updated, in ISO 8601 format.
patch/case/v1/exceptions/{exceptionId}/cases/{caseId}
Authentication
Path Parameters
Body
{}
application/json