ワークフロー・ジョブ・テンプレートの起動
post
/api/v2/workflow_job_templates/{id}/launch/
このリソースに対してGETリクエストを行って、workflow_job_templateを起動できるかどうか、およびworkflow_job_templateを起動するためにパスワードが必要かどうかを判断します。 レスポンスには次のフィールドが含まれます。
can_start_without_user_input: ユーザー入力なしでworkflow_job_templateを起動できるかどうかを示すフラグ(ブール、読取り専用)variables_needed_to_start: workflow_job_templateを起動するために必要な変数名(配列、読取り専用)survey_enabled: workflow_job_templateに有効なサーベイがあるかどうかを示すフラグ(ブール、読取り専用)extra_vars: このworkflow_job_templateのextra_varsフィールドであるテキスト(テキスト、読取り専用)node_templates_missing: nullのunified_job_templateを持つためにブランチの実行を停止させるすべてのノードのノードIDのリスト。(リスト、読取り専用)node_prompts_rejected:unified_job_templateによってこのフィールドのプロンプトが許可されないために拒否されるフィールドが指定されている、すべてのノードのノードIDのリスト。これによってブランチの実行は停止されませんが、フィールドは無視されます(リスト、読取り専用)workflow_job_template_data: このworkflow_job_templateの一般情報をリストするJSONオブジェクト(JSONオブジェクト、読取り専用)
このリソースに対してPOSTリクエストを行って、workflow_job_templateを起動します。 資格証明、インベントリ、プロジェクトまたは追加変数(extra_vars)が必要な場合は、POSTデータを介して渡す必要があります。extra_varsをYAMLまたはJSON文字列として指定し、カッコをエスケープします。
成功した場合、レスポンス・ステータス・コードは201になります。 必要なパスワードが指定されていない場合は、400ステータス・コードが返されます。 ワークフロー・ジョブを起動できない場合は、405ステータス・コードが返されます。 指定された資格証明またはインベントリの使用をユーザーが許可されていない場合は、403ステータス・コードが返されます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
レスポンス
サポートされているメディア・タイプ
- application/json
201レスポンス
レスポンスの例(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",
"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":"",
"workflow_job":1,
"workflow_job_template":3
}400レスポンス
レスポンスの例(application/json)
{
"inventory":[
"The inventory associated with this Workflow is being deleted."
]
}