civis (version 1.2.0)

jobs_list_workflows: 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 object(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

object, 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

object, A list containing the following elements:

• scheduled boolean, If the object 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

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 object(s).

createdAt

string,

updatedAt

string,