1. Oracle Linux Automation Manager CLI and API Reference Guide 2.1
  2. Tasks
  3. Workflow Job Templates

Launch a Workflow Job Template

post

/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
Path Parameters
Body ()
Root Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

Body
Example Response (application/json)
{
    "allow_simultaneous":false,
    "canceled_on":null,
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "elapsed":"0",
    "extra_vars":"{}",
    "failed":false,
    "finished":null,
    "id":"1",
    "ignored_fields":{
    },
    "inventory":null,
    "is_sliced_job":false,
    "job_args":"",
    "job_cwd":"",
    "job_env":{
    },
    "job_explanation":"",
    "job_template":null,
    "launch_type":"manual",
    "launched_by":{
    },
    "limit":null,
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"foobar",
    "related":{
        "activity_stream":"/api/v2/workflow_jobs/1/activity_stream/",
        "cancel":"/api/v2/workflow_jobs/1/cancel/",
        "labels":"/api/v2/workflow_jobs/1/labels/",
        "notifications":"/api/v2/workflow_jobs/1/notifications/",
        "relaunch":"/api/v2/workflow_jobs/1/relaunch/",
        "unified_job_template":"/api/v2/workflow_job_templates/3/",
        "workflow_job_template":"/api/v2/workflow_job_templates/3/",
        "workflow_nodes":"/api/v2/workflow_jobs/1/workflow_nodes/"
    },
    "result_traceback":"",
    "scm_branch":null,
    "started":null,
    "status":"pending",
    "summary_fields":{
        "labels":{
            "count":"0",
            "results":[
            ]
        },
        "unified_job_template":{
            "description":"",
            "id":"3",
            "name":"foobar",
            "unified_job_type":"workflow_job"
        },
        "user_capabilities":{
            "delete":true,
            "start":true
        },
        "workflow_job_template":{
            "description":"",
            "id":"3",
            "name":"foobar"
        }
    },
    "type":"workflow_job",
    "unified_job_template":"3",
    "url":"/api/v2/workflow_jobs/1/",
    "webhook_credential":null,
    "webhook_guid":"",
    "webhook_service":"",
    "work_unit_id":null,
    "workflow_job":"1",
    "workflow_job_template":"3"
}

400 Response

Body
Example Response (application/json)
{
    "inventory":[
        "The inventory associated with this Workflow is being deleted."
    ]
}
Back to Top