client.jobs.list_workflows

A method of the Jobs endpoint.

list_workflows(id: int, *, archived: str = None) → ListResponse

List the workflows a job belongs to

API URL: GET /jobs/{id}/workflows

import civis
client = civis.APIClient()
response = client.jobs.list_workflows(...)

Parameters:

idint

The ID for this job.

archivedstr, optional

The archival status of the items to return. One of: true, false, all. A blank value is read as ‘false’, which is also the default.

Returns:

civis.ListResponse

• idint

  The ID for this workflow.

• namestr

  The name of this workflow.

• descriptionstr

  A description of the workflow.

• validbool

  The validity of the workflow definition.

• file_idstr

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

• usercivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• statestr

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

• schedulecivis.Response

  • scheduledbool

    If the item is scheduled.

  • scheduled_daysList[int]

    Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

  • scheduled_hoursList[int]

    Hours of the day it is scheduled on.

  • scheduled_minutesList[int]

    Minutes of the day it is scheduled on.

  • scheduled_runs_per_hourint

    Deprecated in favor of scheduled minutes.

  • scheduled_days_of_monthList[int]

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

• allow_concurrent_executionsbool

  Whether the workflow can execute when already running.

• time_zonestr

  The time zone of this workflow.

• next_execution_atstr (time)

  The time of the next scheduled execution.

• archivedbool

  The archival status of the requested item(s).

• created_at : str (time)

• updated_at : str (time)