Jump to

• Request
• Response

Launch a Workflow Job Template

get

/api/v2/workflow_job_templates/{id}/launch/

Make a GET request to this resource to determine if the workflow_job_template can be launched and whether any passwords are required to launch the workflow_job_template. The response will include the following fields:

• can_start_without_user_input: Flag indicating if the workflow_job_template can be launched without user-input (boolean, read-only)
• variables_needed_to_start: Required variable names required to launch the workflow_job_template (array, read-only)
• survey_enabled: Flag indicating whether the workflow_job_template has an enabled survey (boolean, read-only)
• extra_vars: Text which is the extra_vars field of this workflow_job_template (text, read-only)
• node_templates_missing: List of node ids of all nodes that have a null unified_job_template, which will cause their branches to stop execution (list, read-only)
• node_prompts_rejected: List of node ids of all nodes that have specified a field that will be rejected because its unified_job_template does not allow prompting for this field, this will not halt execution of the branch but the field will be ignored (list, read-only)
• workflow_job_template_data: JSON object listing general information of this workflow_job_template (JSON object, read-only)

Make a POST request to this resource to launch the workflow_job_template. If any credential, inventory, project or extra variables (extra_vars) are required, they must be passed via POST data, with extra_vars given as a YAML or JSON string and escaped parentheses.

If successful, the response status code will be 201. If any required passwords are not provided, a 400 status code will be returned. If the workflow job cannot be launched, a 405 status code will be returned. If the provided credential or inventory are not allowed to be used by the user, then a 403 status code will be returned.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : WorkflowJobLaunch

Type: object

Show Source

• ask_inventory_on_launch: boolean
  Title: Ask inventory on launch

  Read Only: true
• ask_labels_on_launch: boolean
  Title: Ask labels on launch

  Read Only: true
• ask_limit_on_launch: boolean
  Title: Ask limit on launch

  Read Only: true
• ask_scm_branch_on_launch: boolean
  Title: Ask scm branch on launch

  Read Only: true
• ask_skip_tags_on_launch: boolean
  Title: Ask skip tags on launch

  Read Only: true
• ask_tags_on_launch: boolean
  Title: Ask tags on launch

  Read Only: true
• ask_variables_on_launch: boolean
  Title: Ask variables on launch

  Read Only: true
• can_start_without_user_input: boolean
  Title: Can start without user input

  Read Only: true
• defaults: string
  Title: Defaults

  Read Only: true
• extra_vars: string
  Title: Extra vars
• inventory: integer
  Title: Inventory
• job_tags: string
  Title: Job tags
• labels: array labels
  Unique Items Required: true
• limit: string
  Title: Limit
• node_prompts_rejected: string
  Title: Node prompts rejected

  Read Only: true
• node_templates_missing: string
  Title: Node templates missing

  Read Only: true
• scm_branch: string
  Title: Scm branch
• skip_tags: string
  Title: Skip tags
• survey_enabled: string
  Title: Survey enabled

  Read Only: true
• variables_needed_to_start: string
  Title: Variables needed to start

  Read Only: true
• workflow_job_template_data: string
  Title: Workflow job template data

  Read Only: true

{
    "properties":{
        "ask_inventory_on_launch":{
            "readOnly":true,
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "readOnly":true,
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "readOnly":true,
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "readOnly":true,
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "readOnly":true,
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "readOnly":true,
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "readOnly":true,
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "can_start_without_user_input":{
            "readOnly":true,
            "title":"Can start without user input",
            "type":"boolean"
        },
        "defaults":{
            "readOnly":true,
            "title":"Defaults",
            "type":"string"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string"
        },
        "labels":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "limit":{
            "title":"Limit",
            "type":"string"
        },
        "node_prompts_rejected":{
            "readOnly":true,
            "title":"Node prompts rejected",
            "type":"string"
        },
        "node_templates_missing":{
            "readOnly":true,
            "title":"Node templates missing",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string"
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string"
        },
        "survey_enabled":{
            "readOnly":true,
            "title":"Survey enabled",
            "type":"string"
        },
        "variables_needed_to_start":{
            "readOnly":true,
            "title":"Variables needed to start",
            "type":"string"
        },
        "workflow_job_template_data":{
            "readOnly":true,
            "title":"Workflow job template data",
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : labels

Type: array

Unique Items Required: true

Show Source

• Array of: integer

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

Back to Top