client.workflows.post

A method of the Workflows endpoint.

post(name: str, *, description: str = None, from_job_chain: int = None, definition: str = None, schedule: dict = None, allow_concurrent_executions: bool = None, time_zone: str = None, notifications: dict = None, hidden: bool = None) → Response

Create a Workflow

API URL: POST /workflows

import civis
client = civis.APIClient()
response = client.workflows.post(...)

Parameters:

namestr

The name of this workflow.

descriptionstr, optional

A description of the workflow.

from_job_chainint, optional

If specified, create a workflow from the job chain this job is in, and inherit the schedule from the root of the chain.

definitionstr, optional

The definition of the workflow in YAML format. Must not be specified if fromJobChain is specified.

scheduledict, optional

• 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, optional

Whether the workflow can execute when already running.

time_zonestr, optional

The time zone of this workflow.

notificationsdict, optional

• urlsList[str]

  URLs to receive a POST request at job completion

• success_email_subjectstr

  Custom subject line for success e-mail.

• success_email_bodystr

  Custom body text for success e-mail, written in Markdown.

• success_email_addressesList[str]

  Addresses to notify by e-mail when the job completes successfully.

• failure_email_addressesList[str]

  Addresses to notify by e-mail when the job fails.

• stall_warning_minutesint

  Stall warning emails will be sent after this amount of minutes.

• success_onbool

  If success email notifications are on

• failure_onbool

  If failure email notifications are on

hiddenbool, optional

The hidden status of the item.

Returns:

civis.Response

• idint

  The ID for this workflow.

• namestr

  The name of this workflow.

• descriptionstr

  A description of the workflow.

• definitionstr

  The definition of the workflow in YAML format. Must not be specified if fromJobChain is specified.

• validbool

  The validity of the workflow definition.

• validation_errorsstr

  The errors encountered when validating 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.

• last_execution_idint

  The ID of the most recent execution of this workflow, if any.

• 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.

• notificationscivis.Response

  • urlsList[str]

    URLs to receive a POST request at job completion

  • success_email_subjectstr

    Custom subject line for success e-mail.

  • success_email_bodystr

    Custom body text for success e-mail, written in Markdown.

  • success_email_addressesList[str]

    Addresses to notify by e-mail when the job completes successfully.

  • failure_email_addressesList[str]

    Addresses to notify by e-mail when the job fails.

  • stall_warning_minutesint

    Stall warning emails will be sent after this amount of minutes.

  • success_onbool

    If success email notifications are on

  • failure_onbool

    If failure email notifications are on

• archivedstr

  The archival status of the requested item(s).

• hiddenbool

  The hidden status of the item.

• my_permission_levelstr

  Your permission level on the object. One of “read”, “write”, or “manage”.

• created_at : str (time)

• updated_at : str (time)