jobs_list_workflows {civis}

List the workflows a job belongs to

Description

List the workflows a job belongs to

Usage

jobs_list_workflows(id, archived = NULL)

Arguments

id

integer required.

archived

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

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, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

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

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

• scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes.

• scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.

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,