Search
K
Case Management

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

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}
 
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

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

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
 
application/json

Task Management - Get schema

Get schema for taskType

get

Path Parameters

taskTypestringrequired

Task type

Response

application/json

schema for provided task type

object
get/case/v1/tasks/schema/{taskType}
 
application/json

Retrieve task statistics based on criteria

post

Body

application/json

Criteria for retrieving task statistics

TaskStatsSearchModel

groupByarray[string]required

List of attributes to group the statistics by

Response

application/json

Successful retrieval of task statistics

TaskStatsResponseModel

countinteger

Total number of tasks

statsarray[object]
Show Child Parameters
post/case/v1/tasks/stats

Body

{ "process": "New Business", "carrier": "WELB", "taskName": "Agent Onboarding NIGO", "taskType": "AGENT_ONBOARDING_NIGO", "status": "NEW", "queue": "distribution_and_compensation", "assigneePartyId": "8b19fa3764434c33a54ed1a6151b4c56", "caseId": "CA0000399250", "escalated": false, "taskCreatedOn": "2025-04-04T12:30:33.718936", "sortBy": "taskCreatedOn", "sortDirection": "asc", "offset": "0", "pageSize": "10", "groupBy": [ "status" ] }
 
application/json