Search
K
Case Management

ExceptionListResponse

array

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.

ExceptionReferenceRequest

object
nmIdstring

Unique identifier for the exception reference

Example:EM.057

exceptionTypestring

Exception Type for the exception reference

Example:Business Exception

businessProcessstring

The business process related to the exception

Example:New Business

categorystring

The category of the exception

Example:Agent

reasonstring

The reason for the exception

Example:Training Status

detailedReasonstring

Detailed description of the reason for the exception

Example:The agent's anti-money laundering training was not complete at time of sale.

Example

ExceptionReferenceModel

object
nmIdstring

Unique identifier for the exception reference

Example:EM.057

exceptionTypestring

Exception Type for the exception reference

Example:Business Exception

businessProcessstring

The business process in which the exception occurred

Example:New Business

categorystring

The category of the exception

Example:Agent

reasonstring

The reason for the exception

Example:Training Status

detailedReasonstring

Detailed description of the reason for the exception

Example:The agent's anti-money laundering training was not complete at time of sale.

deletedboolean

Indicates whether the exception reference has been deleted

createdAtstring(date-time)

The date and time when the exception reference was created

Example:2024-09-17T10:00:00Z

updatedAtstring(date-time)

The date and time when the exception reference was last updated

Example:2024-09-17T12:00:00Z

Example

ReferenceResponseModel

object
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.

Example

ReferenceResponseTree

object
typestring

The type of the reference data node.

keystring

The key of the reference data node.

valuestring

The value associated with the reference data node.

childarray[object]

List of child nodes in the reference data hierarchy.

Show Child Parameters
Example