Case Management
ExceptionCreateRequest
objectsourcestring
The system that raised the exception.
Example:Zinnia.OnBase
nmIDstring
The nigo message id.
Example:EM.050
Example
ExceptionCreateResponse
objectexceptionIdstring
The unique identifier of the exception.
Example:EX000000000174
externalIdstring
External identifier from the source system that raised the exception.
Example:23bfac3e-e082-47ef-8619-97e96b17695d
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
messageTypestring
The messageType of the exception.
Example:NIGO
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.
Example
ExceptionPatchRequest
objectsourcestring
The system that raised the exception.
Example:Zinnia.OnBase
exceptionStatusstring
The current status of the exception.
Example:NEW
Example
ExceptionListResponse
arrayAn 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
externalIdstring
External identifier from the source system that raised the exception.
Example:23bfac3e-e082-47ef-8619-97e96b17695d
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
messageTypestring
The messageType of the exception.
Example:NIGO
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.
ExceptionResolveRequest
objectRequest to resolve one or more open exceptions on a case, identified by their externalIds. The case itself is identified by the caseId path parameter, not by a field in this body. Resolving more than one externalId in a single request is all-or-none — if any externalId can’t be found under the given caseId, or isn’t eligible for resolution, none are resolved.
externalIdsarray[string]required
The externalIds of the exceptions to resolve. Must all belong to the caseId in the path.
Example:23bfac3e-e082-47ef-8619-97e96b17695d
Example