ワークフロー・ジョブ・テンプレートの起動
get
/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
パス・パラメータ
問合せパラメータ
- search(オプション): 文字列
検索条件。