Search
K
Case Management

TaskInstanceSummaryModel

object

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

scheduledDatestring(date)

Date for which the task is scheduled

Example:2024-04-02

cancellationReasonstring

Reason for task cancellation

slaDuestring(date-time)

SLA date of the case

prioritystring

Priority level of the task

Example:HIGH

escalatedboolean

Whether the task is escalated

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

Example

TaskMessageModel

object
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

Example

TaskMappedDocument

object

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

documentIdstring

A unique identifier for the document.

Example:abc12345

documentNamestring

The name of the document.

Example:Report_Q1_2024.pdf

documentSourcestring

The origin or source of the document, such as a system name or module.

Example:Zinnia.OnBase

fileTypestring

Type of document, like pdf or an image.

Example:pdf

displayNamestring

Display name of the document.

Example:Replacement of Life Insurance or Annuities

createdDatestring(date-time)

Timestamp when the document was created.

Example

TaskMappedRequestDocument

object

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

documentIdstring

A unique identifier for the document.

Example:abc12345

documentNamestring

The name of the document.

Example:Report_Q1_2024.pdf

documentSourcestring

The origin or source of the document, such as a system name or module.

Example:Zinnia.OnBase

fileTypestring

Type of document, like pdf or an image.

Example:pdf

displayNamestring

Display name of the document.

Example:Replacement of Life Insurance or Annuities

operationTypestring

Specifies the type of operation to be performed on the document.

Allowed values:REMOVEADD

Example:REMOVE

createdDatestring(date-time)

Timestamp when the document was created.

Example

RequestLinkedTask

object

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

taskIdstring

Task Instance Id.

Example:TA000000014642

externalIdstring

The identifier how an external system understand it for example used to map onbase taskId.

Example:23bfac3e-e082-47ef-8619-97e96b17695d

reasonstring

Reason for linking the task.

Example:Identified By BPM

Example