List Workflows

Source: R/generated_client.R

List Workflows

workflows_list(
  hidden = NULL,
  archived = NULL,
  author = NULL,
  state = NULL,
  scheduled = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

hidden

boolean optional. If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.
archived

string optional. The archival status of the requested item(s).
author

string optional. Author of the workflow. It accepts a comma-separated list of author ids.
state

array optional. State of the most recent execution.One or more of queued, running, succeeded, failed, cancelled, idle, and scheduled.
scheduled

boolean optional. If the workflow is scheduled.
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 updated_at. Must be one of: updated_at, name, 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.

name

string, The name of this workflow.

description

string, A description of the workflow.

valid

boolean, The validity of the workflow definition.

fileId

string, The file id for the s3 file containing the workflow configuration.

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.

state

string, The state of the workflow. State is "running" if any execution is running, otherwise reflects most recent execution state.

schedule

list, A list containing the following elements:

  • scheduled boolean, If the item is scheduled.

  • scheduledDays array, Day based on numeric value starting at 0 for Sunday.

  • scheduledHours array, Hours of the day it is scheduled on.

  • scheduledMinutes array, Minutes of the day it is scheduled on.

  • scheduledRunsPerHour integer, Alternative to scheduled minutes, number of times to run per hour.

allowConcurrentExecutions

boolean, Whether the workflow can execute when already running.

timeZone

string, The time zone of this workflow.

nextExecutionAt

string, The time of the next scheduled execution.

archived

string, The archival status of the requested item(s).

createdAt

string,

updatedAt

string,