移動先

• リクエスト
• レスポンス

ワークフロー・ジョブ・テンプレートの起動

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

パス・パラメータ

• id(必須): 文字列

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

本文()

ルート・スキーマ : WorkflowJobLaunch

型: object

ソースを表示

• ask_inventory_on_launch: ブール
  タイトル: Ask inventory on launch

  読取り専用: true
• ask_labels_on_launch: ブール
  タイトル: Ask labels on launch

  読取り専用: true
• ask_limit_on_launch: ブール
  タイトル: Ask limit on launch

  読取り専用: true
• ask_scm_branch_on_launch: ブール
  タイトル: Ask scm branch on launch

  読取り専用: true
• ask_skip_tags_on_launch: ブール
  タイトル: Ask skip tags on launch

  読取り専用: true
• ask_tags_on_launch: ブール
  タイトル: Ask tags on launch

  読取り専用: true
• ask_variables_on_launch: ブール
  タイトル: Ask variables on launch

  読取り専用: true
• can_start_without_user_input: ブール
  タイトル: Can start without user input

  読取り専用: true
• defaults: 文字列
  タイトル: Defaults

  読取り専用: true
• extra_vars: 文字列
  タイトル: Extra vars
• inventory: 整数
  タイトル: Inventory
• job_tags: 文字列
  タイトル: Job tags
• labels: 配列 labels
  一意のアイテムが必要: true
• limit: 文字列
  タイトル: Limit
• node_prompts_rejected: 文字列
  タイトル: Node prompts rejected

  読取り専用: true
• node_templates_missing: 文字列
  タイトル: Node templates missing

  読取り専用: true
• scm_branch: 文字列
  タイトル: Scm branch
• skip_tags: 文字列
  タイトル: Skip tags
• survey_enabled: 文字列
  タイトル: Survey enabled

  読取り専用: true
• variables_needed_to_start: 文字列
  タイトル: Variables needed to start

  読取り専用: true
• workflow_job_template_data: 文字列
  タイトル: Workflow job template data

  読取り専用: 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"
}

ネストされたスキーマ : labels

型: array

一意のアイテムが必要: true

ソースを表示

• 配列: 整数

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

先頭に戻る