nmIdstringrequired
Update an exception reference
put
Path Parameters
Body
application/json
Body
application/json
Updated exception reference details
ExceptionReferenceRequest
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.
Response
application/json
Response
application/json
Exception reference updated successfully
ExceptionReferenceModel
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
Example:false
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
put/case/v1/exceptionrefs/{nmId}
Authentication
Path Parameters
Body
{}
application/json
Assign a task to an user by admin
put
Path Parameters
taskIdstringrequired
Task instance id
Example:TA000000000302
Body
application/json
Body
application/json
assigneePartyIdstringrequired
The ID of the party to whom the task is assigned.
Example:f38705b945ab4193aa2aa6d129194803
Response
application/json
Response
application/json
Task assignment was successful.
TaskAssignmentModel
Represents the assignment details of a task, including process, carrier, and status.
idstring
Unique identifier for the task assignment
Example:TA000000000302
caseIdstring
Identifier for the case associated with the task assignment
Example:CA0000005579
processstring
Process associated with the task assignment
Example:BPM.Redemption
carrierstring
Carrier involved in the task assignment
Example:Carrier_1
taskTypestring
Type of the task
Example:Suitability
taskNamestring
Name of the task
Example:Suitability Review
statusstring
Current status of the task
Allowed values:NEWINPROGRESSSCHEDULEDCANCELLEDCOMPLETED
Example:NEW
queuestring
Name of the queue
Example:suitability_review
identifiersarray[object]
A list of identifiers associated with the task.
Example:[{"identifier":"documentHandle","value":"18389232"},{"identifier":"caseID","value":"9989283"},{"identifier":"contractNumber","value":"5810000002"},{"identifier":"documentNumber","value":"20240715-MAN-389232"}]
Show Child Parameters
createdAtstring(date-time)
Timestamp when the task assignment was created
updatedAtstring(date-time)
Timestamp when the task assignment was last updated
put/case/v1/admin/tasks/{taskId}/assignee
Authentication
Path Parameters
Body
{
"assigneePartyId": "f38705b945ab4193aa2aa6d129194803"
}
application/json
Unassign a task from an user by admin
delete
Path Parameters
taskIdstringrequired
Task instance id
Example:TA000000000302
Response
application/json
Response
application/json
Task un-assignment was successful.
TaskAssignmentModel
Represents the assignment details of a task, including process, carrier, and status.
idstring
Unique identifier for the task assignment
Example:TA000000000302
caseIdstring
Identifier for the case associated with the task assignment
Example:CA0000005579
processstring
Process associated with the task assignment
Example:BPM.Redemption
carrierstring
Carrier involved in the task assignment
Example:Carrier_1
taskTypestring
Type of the task
Example:Suitability
taskNamestring
Name of the task
Example:Suitability Review
statusstring
Current status of the task
Allowed values:NEWINPROGRESSSCHEDULEDCANCELLEDCOMPLETED
Example:NEW
queuestring
Name of the queue
Example:suitability_review
identifiersarray[object]
A list of identifiers associated with the task.
Example:[{"identifier":"documentHandle","value":"18389232"},{"identifier":"caseID","value":"9989283"},{"identifier":"contractNumber","value":"5810000002"},{"identifier":"documentNumber","value":"20240715-MAN-389232"}]
Show Child Parameters
createdAtstring(date-time)
Timestamp when the task assignment was created
updatedAtstring(date-time)
Timestamp when the task assignment was last updated
delete/case/v1/admin/tasks/{taskId}/assignee
Authentication
Path Parameters
application/json
Get all unassigned tasks
Get all unassigned tasks
get
Query Parameters
sizestring
page size
Default:100
pageNostring
page number
Default:0
Response
application/json
Response
application/json
A list of tasks with pagination information
messagestring
Example:Successfully retrieved data!
dataarray[object]
Represents the assignment details of a task, including process, carrier, and status.
Show Child Parameters
countinteger
Example:1
offsetinteger
Example:0
limitinteger
Example:100
totalinteger
Example:1
statusinteger
Example:200
get/case/v1/admin/tasks/unassignments
Authentication
Query Parameters
application/json
Retrieve unassigned tasks
Returns a list of all available unassigned tasks
get
Response
application/json
Response
application/json
Successfully retrieved list of unassigned tasks
Represents the assignment details of a task, including process, carrier, and status.
idstring
Unique identifier for the task assignment
Example:TA000000000302
caseIdstring
Identifier for the case associated with the task assignment
Example:CA0000005579
processstring
Process associated with the task assignment
Example:BPM.Redemption
carrierstring
Carrier involved in the task assignment
Example:Carrier_1
taskTypestring
Type of the task
Example:Suitability
taskNamestring
Name of the task
Example:Suitability Review
statusstring
Current status of the task
Allowed values:NEWINPROGRESSSCHEDULEDCANCELLEDCOMPLETED
Example:NEW
queuestring
Name of the queue
Example:suitability_review
identifiersarray[object]
A list of identifiers associated with the task.
Example:[{"identifier":"documentHandle","value":"18389232"},{"identifier":"caseID","value":"9989283"},{"identifier":"contractNumber","value":"5810000002"},{"identifier":"documentNumber","value":"20240715-MAN-389232"}]
Show Child Parameters
createdAtstring(date-time)
Timestamp when the task assignment was created
updatedAtstring(date-time)
Timestamp when the task assignment was last updated
get/case/v1/tasks/unassignments
Authentication
application/json