From 20bb2ed71c8210502cdad1a917b97136302b1625 Mon Sep 17 00:00:00 2001 From: James Laska Date: Thu, 23 Oct 2014 12:51:00 -0400 Subject: [PATCH] Additional markdown for job_template launch endpoint Fixes: https://trello.com/c/h4rfafWM --- awx/api/templates/api/job_template_launch.md | 22 +++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/awx/api/templates/api/job_template_launch.md b/awx/api/templates/api/job_template_launch.md index 5167f2ec6b..bbee46ebcc 100644 --- a/awx/api/templates/api/job_template_launch.md +++ b/awx/api/templates/api/job_template_launch.md @@ -1,3 +1,23 @@ Launch a Job Template: -Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint. \ No newline at end of file +Make a GET request to this resource to determine if the job_template can be +launched and whether any passwords are required to launch the job_template. +The response will include the following fields: + +* `ask_variables_on_launch`: Flag indicating whether the job_template is + configured to prompt for variables upon launch (boolean, read-only) +* `can_start_without_user_input`: Flag indicating if the job_template can be + launched without user-input (boolean, read-only) +* `passwords_needed_to_start`: Password names required to launch the + job_template (array, read-only) +* `variables_needed_to_start`: Required variable names required to launch the + job_template (array, read-only) +* `survey_enabled`: Flag indicating if whether the job_template has an enabled + survey (boolean, read-only) + +Make a POST request to this resource to launch the job_template. If any +passwords or variables are required, they must be passed via POST data. + +If successful, the response status code will be 202. If any required passwords +are not provided, a 400 status code will be returned. If the job cannot be +launched, a 405 status code will be returned.