Search
K
Case Management

Update Task By CaseId and TaskId

Update task through provided input

put

Path Parameters

caseIdstringrequired

Case Instance Id

Example:CA0000005579

taskIdstringrequired

Task Instance Id

Example:TA000000000302

Body

application/json

Task details for Updation

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

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/v2/cases/{caseId}/tasks/{taskId}

Body

{}
 
application/json

Task Form Metadata

Retrieve a form Metadata

get

Query Parameters

processstringrequired

The process for which the form Metadata is needed.

taskTypestringrequired

The type of task associated with the form Metadata.

carrierstring

(Optional) The carrier associated with the form Metadata.

Response

application/json

Successfully retrieved form Metadata.

FormMetadataModel

formIdstring

Example:67056202d7795c98bf36f5f1

processstring

Example:New Business

carrierstring

Example:Carrier_1

taskTypestring

Example:Suitability

formSchemaobject
Show Child Parameters
uiSchemaobject
Show Child Parameters
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
get/case/v1/form/metadata
 
application/json

Create form metadata

Creates the form metadata

post

Body

application/json

FormMetadataRequest

carrierstring

Carrier for the metadata.

Example:CarrierName_1

processstring

Process for the metadata

Example:New Business

taskTypestring

Task type for the metadata

Example:SUITABILITY_REVIEW

formSchemaobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
uiSchemaobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.

Response

application/json

Successful operation

FormMetadataModel

formIdstring

Example:67056202d7795c98bf36f5f1

processstring

Example:New Business

carrierstring

Example:Carrier_1

taskTypestring

Example:Suitability

formSchemaobject
Show Child Parameters
uiSchemaobject
Show Child Parameters
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
post/case/v1/form/metadata

Body

{}
 
application/json

Update form based on formId

Update form based on formId.

put

Path Parameters

formIdstringrequired

Form id

Example:formId

Response

application/json

Successful operation

FormMetadataModel

formIdstring

Example:67056202d7795c98bf36f5f1

processstring

Example:New Business

carrierstring

Example:Carrier_1

taskTypestring

Example:Suitability

formSchemaobject
Show Child Parameters
uiSchemaobject
Show Child Parameters
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
put/case/v1/form/metadata/{formId}
 
application/json