Search
K
Case Management

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

AssigneeDetails

object

Assignee search criteria. When provided in task search, the service resolves matching users and filters tasks by their assignee partyIds.

firstNamestring

Assignee first name (search criterion).

Example:John

lastNamestring

Assignee last name (search criterion).

Example:Doe

emailstring

Assignee email address (search criterion).

Example:john.doe@example.com

fullNamestring

Assignee full name (search criterion).

Example:John Doe

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

LinkedTask

object

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

taskIdstring

Task Instance Id.

Example:TA000000014642

reasonstring

Reason for linking the task.

Example:Identified By BPM

Example

TaskAssignmentModel

object

Represents the assignment details of a task, including process, carrier, and status.

idstring

Unique identifier for the task assignment

Example:TA000000000302

caseIdstring

Identifier for the case associated with the task assignment

Example:CA0000005579

processstring

Process associated with the task assignment

Example:BPM.Redemption

carrierstring

Carrier involved in the task assignment

Example:Carrier_1

taskTypestring

Type of the task

Example:Suitability

taskNamestring

Name of the task

Example:Suitability Review

statusstring

Current status of the task

Allowed values:NEWINPROGRESSSCHEDULEDCANCELLEDCOMPLETED

Example:NEW

queuestring

Name of the queue

Example:suitability_review

identifiersarray[object]

A list of identifiers associated with the task.

Example:{"identifier":"documentHandle","value":"18389232"}{"identifier":"caseID","value":"9989283"}{"identifier":"contractNumber","value":"5810000002"}{"identifier":"documentNumber","value":"20240715-MAN-389232"}

Show Child Parameters
createdAtstring(date-time)

Timestamp when the task assignment was created

updatedAtstring(date-time)

Timestamp when the task assignment was last updated

Example