workflows_list_executions {civis}

List workflow executions

Description

List workflow executions

Usage

workflows_list_executions(
  id,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

id

integer required. The ID for this workflow.

limit

integer optional. Number of results to return. Defaults to 20. Maximum allowed is 50.

page_num

integer optional. Page number of the results to return. Defaults to the first page, 1.

order

string optional. The field on which to order the result set. Defaults to id. Must be one of: id, updated_at, created_at.

order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

Value

An array containing the following fields:

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.

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.