Search
K
Case Management

Update Task

DEPRECATED

Updates task for a given case

put

Path Parameters

caseIdstringrequired

Case instance id

taskIdstringrequired

Task instance id

Body

application/json

TaskUpdateRequest

taskTypestring

Example:WithdrawalTask

carrierstring

Example:CarrierName_2

statusstring

Example:DRAFT

dataOne Of
WithdrawalTaskDataobject
Show Child Parameters

Response

application/json

Renewal task created

TaskSummary

taskIdstring(23432-234234-324234-5345434)
caseIdstring(34545-543453-323223-534522)
taskTypestring

Example:RenewalTask

statusstring

Example:Pending

sourcestring

Example:SupportTool

carrierstring

Example:CarrierName_1

assignedTostring

Example:operator-3

createdDatestring(date-time)
createdBystring

Example:operator-1

updatedDatestring(date-time)
updatedBystring

Example:operator-2

put/case/v1/cases/{caseId}/tasks/{taskId}

Body

{}
 
application/json

Get Task details

DEPRECATED

Get Task details from a case with task id

get

Path Parameters

caseIdstringrequired

Case instance id

taskIdstringrequired

Task instance id

Response

application/json

task details retrieved

TaskInstance

taskIdstring(23432-234234-324234-5345434)
caseIdstring(34545-543453-323223-534522)
taskTypestring

Example:RenewalTask

statusstring

Example:Pending

sourcestring

Example:SupportTool

carrierstring

Example:CarrierName_1

assignedTostring

Example:operator-3

createdDatestring(date-time)
createdBystring

Example:operator-1

updatedDatestring(date-time)
updatedBystring

Example:operator-2

dataOne Of
RenewalTaskDataobject
Show Child Parameters
get/case/v1/cases/{caseId}/tasks/{taskId}
 
application/json

Get Task

DEPRECATED

Get Task

get

Path Parameters

taskIdstringrequired

Task instance id

Response

application/json

task instance retrieved

TaskInstance

taskIdstring(23432-234234-324234-5345434)
caseIdstring(34545-543453-323223-534522)
taskTypestring

Example:RenewalTask

statusstring

Example:Pending

sourcestring

Example:SupportTool

carrierstring

Example:CarrierName_1

assignedTostring

Example:operator-3

createdDatestring(date-time)
createdBystring

Example:operator-1

updatedDatestring(date-time)
updatedBystring

Example:operator-2

dataOne Of
RenewalTaskDataobject
Show Child Parameters
get/case/v1/tasks/{taskId}
 
application/json

Task Instance (Task Management)

Manages tasks based on cases. Implemented using Zinnia Live Task management framework.

Update task by admin

Updates a task with administrative privileges

put

Path Parameters

taskIdstringrequired

Task instance id

Example:TA000000014789

Body

application/json

TaskRequest

idstring | null

Example:36be3d51-2246-4158-9feb-a29fe5bd0183

sourcestring

Example:Zinnia.OnBase

taskTypestring

Example:Suitability

statusstring

Example:NEW

scheduledReasonstring

Example:DOCUMENT_MISSING

scheduledDatestring(date-time)
cancellationReasonstring

Example:CASE_CANCELATION

mappedExceptionsarray[string]

Exceptions to be linked the task

Example:["EX000000000188"]

mappedDocumentsarray[object]

Metadata for a document mapped to a specific task in the system.

Show Child Parameters
dataobject

Example:{}

linkedTasksarray[object]

Metadata for a linked tasks to a specific task in the system.

Show Child Parameters

Response

application/json

Task updated successfully

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

put/case/v1/admin/tasks/{taskId}

Body

{}
 
application/json