taskIdstringrequired
Assign the task to the partyId received in the token
Example:TA000000000302
Unassign the task by taskId
delete
Path Parameters
Response
application/json
Response
application/json
Task successfully unclaimed
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/tasks/{taskId}/assignments
Path Parameters
application/json
Get all assigned task
Get all assigned task for current logged in user
get
Response
application/json
Response
application/json
List of all assigned task for currently logged in user
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/assigned
Authentication
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/unassigned
Authentication
application/json
Task Management - Create a new Task message
Create a new task message for the specified task type, carrier, category, and message ID.
post
Body
application/json
Body
application/json
taskTypestring
Type of the task
Example:SUITABILITY_REVIEW
carrierstring
Carrier information
Example:MASS
categorystring
Category of the message
Allowed values:SCHEDULED_REASONCANCELLATION_REASON
Example:SCHEDULED_REASON
messageIdstring
Unique identifier for the message
Example:DOCUMENT_MISSING
messagestring
The description of the message
Example:Document is missing for SUITABILITY_REVIEW for MASS
Response
application/json
Response
application/json
Task message created successfully
TaskMessageModel
taskTypestring
Type of the task
Example:SUITABILITY_REVIEW
carrierstring
Carrier information
Example:MASS
categorystring
Category of the message
Example:CANCELLATION_REASON
messageIdstring
Unique identifier for the message
Example:DOCUMENT_MISSING
messagestring
The description of the message
Example:DOCUMENT is missing for SUITABILITY_REVIEW for MASS
post/case/v1/tasks/message
Authentication
Body
{}
application/json
Task Management - Search Task Messages
Search task messages by task type, carrier, category, and message ID.
post
Body
application/json
Body
application/json
categorystring
Category of the message
Allowed values:SCHEDULED_REASONCANCELLATION_REASON
Example:SCHEDULED_REASON
messageIdstring
Unique identifier for the message
Example:DOCUMENT_MISSING
Response
application/json
Response
application/json
Task messages retrieved successfully
taskTypestring
Type of the task
Example:SUITABILITY_REVIEW
carrierstring
Carrier information
Example:MASS
categorystring
Category of the message
Example:CANCELLATION_REASON
messageIdstring
Unique identifier for the message
Example:DOCUMENT_MISSING
messagestring
The description of the message
Example:DOCUMENT is missing for SUITABILITY_REVIEW for MASS
post/case/v1/tasks/message/search
Authentication
Body
{}
application/json