workflows_get_executions_tasks {civis}

Get a task of a workflow execution

Description

Get a task of a workflow execution

Usage

workflows_get_executions_tasks(id, execution_id, task_name)

Arguments

id

integer required. The ID for the workflow.

execution_id

integer required. The ID for the workflow execution.

task_name

string required. The URL-encoded name of the task.

Value

A list containing the following elements:

name

string, The name of the task.

mistralState

string, The state of this task. One of idle, waiting, running, delayed, success, error, or cancelled

mistralStateInfo

string, Extra info associated with the state of the task.

runs

array, An array containing the following fields:

• id integer, The ID of the run.

• jobId integer, The ID of the job associated with the run.

• myPermissionLevel string, Your permission level on the job. One of "read", "write", "manage", or "nil".

• state string, The state of the run.

• createdAt string, The time that the run was queued.

• startedAt string, The time that the run started.

• finishedAt string, The time that the run completed.

executions

array, An array containing the following fields:

• id integer, The ID of the execution.

• workflowId integer, The ID of the workflow associated with the execution.

• myPermissionLevel string, Your permission level on the workflow. One of "read", "write", "manage", or "nil".

• state string, The state of this workflow execution.

• createdAt string, The time this execution was created.

• startedAt string, The time this execution started.

• finishedAt string, The time this execution finished.