caseIdstring
taskTypestring
sortBystring
Allowed values:updatedAtcreatedAt
sortDirectionstring
Allowed values:ascdesc
offsetinteger(int32)
limitinteger(int32)
Task Management - Search tasks
Search tasks by case id for provided criteria
post
Body
application/json
Body
application/json
Response
application/json
Response
application/json
tasks retrieved for provided search criterias
dataarray[object]
Represents the details of the task, including exceptions, data, and schema.
Show Child Parameters
countinteger(int32)
Example:1
offsetinteger(int32)
Example:0
limitinteger(int32)
Example:10
totalinteger(int32)
Example:1
statusinteger(int32)
Example:200
messagestring
Example:Successfully retrieved data!
post/case/v1/tasks/search
Authentication
Body
{
"caseId": "CA0000005579",
"taskType": "Suitability",
"sortBy": "createdAt",
"sortDirection": "asc",
"offset": 0,
"limit": 20
}
application/json
Task Management - Search tasks via elastic
Search tasks by case id for provided criteria
post
Body
application/json
Body
application/json
TaskSearchModel
processstring
A list of processes to filter the search results.
carriersarray[string]
The carrier associated with the task.
taskNamestring
Name of the task.
taskTypestring
Task Type
taskDetailsstring
Associated Task Details
statusesarray[string]
A list of task statuses to filter the search results.
queuesarray[string]
A list of queue associated with the task to filter the search results.
assigneePartyIdstring
Assignee Party task filter
caseIdstring
escalatedboolean
Escalated or Not escalated task filter
carrierstring
statusstring
queuestring
taskCreatedOnstring(date-time)
The created date for the task range filter.
identifiersarray[object]
A list of case identifier to search task.
Show Child Parameters
sortBystring
The field by which to sort the search results.
sortDirectionstring
The direction to sort the search results, either ascending (asc) or descending (desc).
offsetstring
The offset for pagination, indicating the starting point for the results.
pageSizestring
The maximum number of results to return.
Response
application/json
Response
application/json
tasks retrieved for provided search criterias
dataarray[object]
Represents the details of the task, including exceptions, data, and schema.
Show Child Parameters
countinteger(int32)
Example:1
offsetinteger(int32)
Example:0
limitinteger(int32)
Example:10
totalinteger(int32)
Example:1
statusinteger(int32)
Example:200
messagestring
Example:Successfully retrieved data!
post/case/v2/tasks/search
Authentication
Body
{}
application/json
Task Management - Get Task details
Get Task details
get
Query Parameters
includeSchemaboolean
Whether schema should be included or not
Default:false
Path Parameters
taskIdstringrequired
Task instance id
Example:TA000000000302
Response
application/json
Response
application/json
task details retrieved
TaskInstanceModel
Represents the details of the task, including exceptions, data, and schema.
idstring
Unique identifier for the task instance
Example:TA000000000302
caseIdstring
Identifier for the case related to the task
Example:CA0000005579
sourcestring
Source of the task instance
Example:BPM.Redemption
externalIdstring
External task identifier
Example:9755818
templateIdstring
Identifier for the template used
Example:aedb60fb-48b1-4b87-a7a2-57593c39cbb1
processstring
Process associated with the task
Example:New Business
carrierstring
Carrier associated with the task
Example:Carrier_1
taskTypestring
Type of the task
Example:Suitability
taskNamestring
Name of the task
Example:Suitability Review
taskDetailsstring
Details of the task
Example:Important task details..
statusstring
Current status of the task
Allowed values:NEWINPROGRESSSCHEDULEDCANCELLEDCOMPLETED
Example:NEW
dataobject
Additional data related to the task
Example:{}
* Additional properties are allowed.
mappedExceptionsarray[string]
Exceptions linked to the task
Example:["EX000000000188"]
mappedDocumentsarray[object]
Metadata for a document mapped to a specific task in the system.
Show Child Parameters
linkedTasksarray[object]
Metadata for a linked tasks to a specific task in the system.
Show Child Parameters
queuestring
Queue to which the task is assigned
Example:queue_withdrawal
scheduledReasonstring
Reason why the task is scheduled to later time
Example:[ "" ]
scheduledDatestring(date)
Date for which the task is scheduled
Example:2024-04-02
cancellationReasonstring
Reason for task cancellation
Example:[ "" ]
slaDuestring(date-time)
SLA date of the case
prioritystring
Priority level of the task
Example:HIGH
escalatedboolean
Whether the task is escalated
Default:false
Example:false
assigneeFirstNamestring
First Name of the User assigned to the task
Example:Great
assigneeLastNamestring
Last Name of the User assigned to the task
Example:Gatsby
assigneestring
Email Id of the User assigned to the task
Example:Great.Gatsby@zinnia.com
assigneePartyIdstring
Party Id of the User assigned to the task
Example:53dfb347558f42cfb79a0ef3a1147acb
assignedAtstring(date-time)
Timestamp when the task was assigned to the User
preferredAssigneestring
Preferred user for task assignment
Example:username@se2.com
createdBystring
Email Id of the User who created the task
Example:username@se2.com
createdByPartyIdstring
Party Id of the User who created the task
Example:8170b3a1353848d589399254210772ae
createdAtstring(date-time)
Timestamp when the task was created
updatedBystring
Email Id of the User who last updated the task
Example:Satyam.Srivastava@zinnia.com
updatedByPartyIdstring
Party Id of the User who last updated the task
Example:53dfb347558f42cfb79a0ef3a1147acb
updatedAtstring(date-time)
Timestamp when the task was last updated
schemaobject
Example:{"schema":"http://json-schema.org/draft-04/schema#","type":"object","properties":{"suitabilityStatus":{"type":"string"},"notes":{"type":"array","items":{"type":"object","properties":{"submissionDate":{"type":"string"},"commentCategory":{"type":"string"},"commentSubCategory":{"type":"string"},"commentDetail":{"type":"string"},"comment":{"type":"string"},"description":{"type":"string"},"createdDate":{"type":"string"},"createBy":{"type":"string"},"noteId":{"type":"integer"}},"required":["submissionDate","commentCategory","commentSubCategory","commentDetail","comment","description","createdDate","createBy","noteId"]}}},"required":["suitabilityStatus"]}
get/case/v2/tasks/{taskId}
Authentication
Path Parameters
Query Parameters
application/json
Task Management - Get Task Assignee Summary
Get Task Assignee Summary by Case ID
get
Path Parameters
caseIdstringrequired
Case instance id
Example:CA0000425395
Response
application/json
Response
application/json
task assignee summary retrieved
TaskAssigneeSummaryModel
caseIdstring
The unique identifier of the case
tasksarray[object]
List of tasks for the case, each with unique assignee details
Show Child Parameters
get/case/v1/cases/{caseId}/tasks/assignee-summary
Authentication
Path Parameters
application/json
Task Management - Get Exceptions
Get exception details by task id
get
Path Parameters
taskIdstringrequired
Task instance id
caseIdstringrequired
Case instance id
Response
application/json
Response
application/json
exceptions for provided case and task retrieved
ExceptionListInstance
idstring
Unique Identifier for Exception Instance
statusstring
Status of Exception Instance
Allowed values:NEWRESOLVED
exceptionRefIdstring
The exceptionRefId of the exception.
Example:NB.EM.068
exceptionTypestring
The exceptionType of the exception.
Example:Business Exception
categorystring
Category of Exception
reasonstring
Short description of Exception
detailedReasonstring
Detailed description of Exception
updatedAtstring
Last updated timestamp of Exception
taskIdListarray[string]unique-items
List of Task Identifier associated with Exception Instance
additionalDataobject
exceptionAdditionalDataarray[object]
Additional data related to the Exception.
Show Child Parameters
eventRefarray[string]
List of Events associated with Exception Instance
get/case/v1/cases/{caseId}/tasks/{taskId}/exceptions
Authentication
Path Parameters
application/json