Jump to

• Request
• Response

Create a Schedule for a System Job Template

post

/api/v2/system_job_templates/{id}/schedules/

Make a POST request to this resource with the following schedule fields to create a new schedule associated with this system 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)

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

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : schema

Type: object

Show Source

• description: string
• diff_mode: boolean
• enabled: boolean
  Enables processing of this schedule.
• extra_data: string
• inventory: integer
  Inventory applied as a prompt, assuming job template prompts for inventory
• job_tags: string
• job_type: string
• limit: string
• name(required): string
• rrule(required): string
  A value representing the schedules iCal recurrence rule.
• scm_branch: string
• skip_tags: string
• unified_job_template(required): integer
• verbosity: string

{
    "properties":{
        "description":{
            "description":"",
            "type":"string"
        },
        "diff_mode":{
            "description":"",
            "type":"boolean"
        },
        "enabled":{
            "description":"Enables processing of this schedule.",
            "type":"boolean"
        },
        "extra_data":{
            "description":"",
            "type":"string"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "type":"integer"
        },
        "job_tags":{
            "description":"",
            "type":"string"
        },
        "job_type":{
            "description":"",
            "type":"string"
        },
        "limit":{
            "description":"",
            "type":"string"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "rrule":{
            "description":"A value representing the schedules iCal recurrence rule.",
            "type":"string"
        },
        "scm_branch":{
            "description":"",
            "type":"string"
        },
        "skip_tags":{
            "description":"",
            "type":"string"
        },
        "unified_job_template":{
            "description":"",
            "type":"integer"
        },
        "verbosity":{
            "description":"",
            "type":"string"
        }
    },
    "required":[
        "rrule",
        "name",
        "unified_job_template"
    ],
    "type":"object"
}

Back to Top

Response

201 Response

Back to Top