PathwayTaskOverviewData

An overview of a single task within a pathway.

Properties

Key

string

The key of the task.

Name

string

The name of the task.

ActionType

string

The type of the task. See Pathway structure and task types.

ActionTypeName

string

The user-friendly name of the action type.

StateType

string

The state of the task.

  • FT – Future pending task, not-started yet
  • ST – Started task
  • IP – Task in progress
  • CP – Task completed
  • SK – Task has been skipped
  • FL – Task failed

Note that even if the task is in ST (Started) state the client need to check CanProcess field to allow any action.

StateName

string

The user-friendly name of the state.

CanProcess

bool

True if the task and the logged-in user has rights to process the task.

Tasks

PathwayTaskOverviewData[]

The list of nested tasks.

JSON Example

{
    "Name": "AA",
    "ActionType": "AA",
    "ActionTypeName": "Arrive an appointment",
    "StateType": "FT",
    "StateName": "Future task",
    "CanProcess": false,
    "Key": "86149d568252ae476859a3a60835369b"
}