Search
K
Case Management

NoteInstance

object
idstring

A unique identifier of Note

notestring

The Text content of Note

authorstring

Author of note

internalboolean

Indicates whether the item is internal or not.

createdAtstring

The timestamp of Note been created

updatedAtstring

The timestamp of Note been updated

Example:09-April-2023

descstring

Description of note

additionalDataobject
eventRefarray[string]

List of Events associated with Note Instance

Example

TaskLinkInstance

object
idstring

A Unique identifier of Task in Task Management

taskTypestring

Business friendly type for Task

labelstring

Business friendly Label for Task

assigneestring

User currently assigned to the task

statusstring

Status of Task (STATUS DISCUSSION IN PROGRESS)

Allowed values:OPENCLOSEDNEWCOMPLETEDCOMPLETE

taskNamestring

task name of the task

queuestring

Queue to which the task is assigned

createdAtstring

Timestamp when the Task was created

updatedAtstring

Timestamp when the Task was last updated

eventRefarray[string]

List of Events associated with Note Instance

externalTaskIdstring

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

notesIdListarray[string]

List of Note identifiers associated to Task

Example

AdditionalDataInstance

object

StageInstance

object
idstring

Unique identifier for the stage instance.

labelstring

Business Friendly label for the stage instance.

stageStatusstring

Current status of the stage instance.

Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDNOT_STARTED

mappedTasksarray[string]

List of identifiers for tasks mapped to this stage (RESERVED FOR FUTURE SCOPE).

mappedNotesarray[string]

List of identifiers for notes mapped to this stage (RESERVED FOR FUTURE SCOPE).

stepsarray[object]

List of step instances that make up this stage.

Show Child Parameters
createdAtstring(date-time)

Timestamp when the stage instance was created.

Example

StepInstance

object
idstring

Unique identifier for the step instance.

labelstring

Business Friendly label for the step instance.

stepStatusstring

Current status of the step instance.

Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDNOT_STARTED

stepResultstring

Step level decision outcome

eventRefarray[string]

List of event references associated with this step.

mappedTasksarray[string]

List of identifiers for tasks mapped to this step.

mappedExceptionsarray[string]

List of exception mapped to this step.

mappedDocumentsarray[string]

List of document id mapped to this step.

mappedCasesarray[string]

List of Case id mapped to this step.

mappedNotesarray[string]

List of identifiers for notes mapped to this step (RESERVED FOR FUTURE SCOPE).

multiInstanceboolean

Indicates whether step is multiple instance or not.

Default:false

instanceInfoobject

Contains information about the multi instance step

Show Child Parameters
createdAtstring(date-time)

Timestamp when the step instance was created.

updatedAtstring(date-time)

Timestamp when the step instance was last updated.

Example