Create a Schedule for a Workflow Job Template

post

/api/v2/workflow_job_templates/{id}/schedules/

Make a POST request to this resource with the following schedule fields to create a new schedule associated with this workflow job template.

  • rrule: A value representing the schedules iCal recurrence rule. (string, required)

  • name: Name of this schedule. (string, required)

  • description: Optional description of this schedule. (string, default="")
  • extra_data: (json, default={})
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
  • scm_branch: (string, default="")
  • job_type: (choice)
    • None: --------- (default)
    • "": ---------
    • run: Run
    • check: Check
  • job_tags: (string, default="")
  • skip_tags: (string, default="")
  • limit: (string, default="")
  • diff_mode: (boolean, default=None)
  • verbosity: (choice)
    • None: --------- (default)
    • 0: 0 (Normal)
    • 1: 1 (Verbose)
    • 2: 2 (More Verbose)
    • 3: 3 (Debug)
    • 4: 4 (Connection Debug)
    • 5: 5 (WinRM Debug)
  • execution_environment: The container image to be used for execution. (id, default=``)
  • forks: (integer, default=None)
  • job_slice_count: (integer, default=None)
  • timeout: (integer, default=None)

  • enabled: Enables processing of this schedule. (boolean, default=True)

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : Schedule
Type: object
Show Source
Nested Schema : Extra data
Type: object
Title: Extra data
Back to Top

Response

Supported Media Types

201 Response

Body ()
Root Schema : Schedule
Type: object
Show Source
Nested Schema : Extra data
Type: object
Title: Extra data
Back to Top