PathwayTaskData

A full task description within a pathway.

Properties

Parameter	Type	Description
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.
Description	string	The description of the task.
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.
AppointmentTask	AppointmentTaskData	The details about the book/arrive appointment task.
AttachDocumentTask	AttachDocumentTaskData	The details about the attach document task.
ChoiceTask	ChoiceTaskData	The details about the choice task.
QuestionnaireTask	QuestionnaireTaskData	The details about the questionnaire task.

JSON Example

{
    "Name": "AA",
    "ActionType": "AA",
    "ActionTypeName": "Arrive an appointment",
    "Description": "Please arrive to your appointment.",
    "StateType": "FT",
    "StateName": "Future task",
    "CanProcess": false,
    "AppointmentTask": {
        "AppointmentType": "0001a9748715e6a2",
        "AppointmentTypeName": "Consultation",
        "IsBooked": false
    },
    "Key": "86149d568252ae476859a3a60835369b"
}