workflows_post_executions {civis}

Execute a workflow

Description

Execute a workflow

Usage

workflows_post_executions(
  id,
  target_task = NULL,
  input = NULL,
  included_tasks = NULL
)

Arguments

id

integer required. The ID for the workflow.

target_task

string optional. For a reverse workflow, the name of the task to target.

input

list optional. Key-value pairs to send to this execution as inputs.

included_tasks

array optional. If specified, executes only the subset of workflow tasks included as specified by task name.

Value

A list containing the following elements:

id

integer, The ID for this workflow execution.

state

string, The state of this workflow execution.

mistralState

string, The state of this workflow as reported by mistral. One of running, paused, success, error, or cancelled

mistralStateInfo

string, The state info of this workflow as reported by mistral.

user

list, A list containing the following elements:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.

definition

string, The definition of the workflow for this execution.

input

list, Key-value pairs defined for this execution.

includedTasks

array, The subset of workflow tasks selected to execute.

tasks

array, An array containing the following fields:

• 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, The runs associated with this task, in descending order by id.

• executions array, The executions run by this task, in descending order by id.

startedAt

string, The time this execution started.

finishedAt

string, The time this execution finished.

createdAt

string, The time this execution was created.

updatedAt

string, The time this execution was last updated.