移動先

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

ワークフロー・ジョブ・テンプレート・ノードの更新

patch

/api/v2/workflow_job_template_nodes/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、このワークフロー・ジョブ・テンプレート・ノードを更新します。次のフィールドを変更できます。

• extra_data: (json、デフォルト={})
• inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id、デフォルト=``)
• scm_branch: (文字列、デフォルト="")
• job_type: (選択)
  • None: --------- (デフォルト)
  • "": ---------
  • run: 実行
  • check: チェック
• job_tags: (文字列、デフォルト="")
• skip_tags: (文字列、デフォルト="")
• limit: (文字列、デフォルト="")
• diff_mode: (ブール、デフォルト=None)
• verbosity: (選択)
  • None: --------- (デフォルト)
  • 0: 0 (標準)
  • 1: 1 (詳細)
  • 2: 2 (より詳細)
  • 3: 3 (デバッグ)
  • 4: 4 (接続デバッグ)
  • 5: 5 (WinRMデバッグ)
• execution_environment: 実行に使用されるコンテナ・イメージ。(id、デフォルト=``)
• forks: (整数、デフォルト=None)
• job_slice_count: (整数、デフォルト=None)
• timeout: (整数、デフォルト=None)
• workflow_job_template: (id、必須)

• unified_job_template: (id、デフォルト=`)

• all_parents_must_converge: 有効にした場合、すべての親ノードがこのノードにアクセスするための基準を満たしている場合にのみノードが実行されます(ブール、デフォルト=False)

• identifier: そのワークフロー内で一意のこのノードの識別子。これはこのノードに対応するワークフロー・ジョブ・ノードにコピーされます。(文字列、デフォルト="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")

PATCHリクエストの場合は、変更中のフィールドのみを含めます。

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : WorkflowJobTemplateNodeDetail

型: object

ソースを表示

• all_parents_must_converge: ブール
  タイトル: All parents must converge

  有効にした場合、すべての親ノードがこのノードにアクセスするための基準を満たしている場合にのみノードが実行されます
• always_nodes: 配列 always_nodes
  読取り専用: true

  一意のアイテムが必要: true
• created: 文字列
  タイトル: Created

  読取り専用: true
• diff_mode: ブール
  タイトル: Diff mode
• execution_environment: 整数
  タイトル: Execution environment

  実行に使用されるコンテナ・イメージ。
• extra_data: オブジェクト Extra data
  タイトル: Extra data
• failure_nodes: 配列 failure_nodes
  読取り専用: true

  一意のアイテムが必要: true
• forks: 整数
  タイトル: Forks

  最小値: 0
• id: 整数
  タイトル: ID

  読取り専用: true
• identifier: 文字列
  タイトル: Identifier

  最小長: 1

  最大長: 512

  デフォルト値: 00000000-0000-0000-0000-000000000000

  そのワークフロー内で一意のこのノードの識別子。これはこのノードに対応するワークフロー・ジョブ・ノードにコピーされます。
• inventory: 整数
  タイトル: Inventory

  プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する)
• job_slice_count: 整数
  タイトル: Job slice count

  最小値: 0
• job_tags: 文字列
  タイトル: Job tags
• job_type: 文字列
  タイトル: Job type

  指定できる値: [ "run", "check" ]
• limit: 文字列
  タイトル: Limit
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• related: 文字列
  タイトル: Related

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

  一意のアイテムが必要: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• timeout: 整数
  タイトル: Timeout
• type: 文字列
  タイトル: Type

  読取り専用: true
• unified_job_template: 整数
  タイトル: Unified job template
• url: 文字列
  タイトル: Url

  読取り専用: true
• verbosity: 文字列
  タイトル: Verbosity

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]
• workflow_job_template(必須): 文字列
  タイトル: Workflow job template

{
    "properties":{
        "all_parents_must_converge":{
            "description":"If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node",
            "title":"All parents must converge",
            "type":"boolean",
            "x-nullable":true
        },
        "always_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "failure_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "identifier":{
            "default":"00000000-0000-0000-0000-000000000000",
            "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.",
            "maxLength":"512",
            "minLength":"1",
            "title":"Identifier",
            "type":"string",
            "x-nullable":true
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "success_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "title":"Unified job template",
            "type":"integer",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        },
        "workflow_job_template":{
            "title":"Workflow job template",
            "type":"string"
        }
    },
    "required":[
        "workflow_job_template"
    ],
    "type":"object"
}

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

型: array

読取り専用: true

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

ソースを表示

• 配列: 整数

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

ネストされたスキーマ : Extra data

型: object

タイトル: Extra data

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

型: array

読取り専用: true

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

ソースを表示

• 配列: 整数

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

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

型: array

読取り専用: true

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

ソースを表示

• 配列: 整数

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : WorkflowJobTemplateNodeDetail

型: object

ソースを表示

• all_parents_must_converge: ブール
  タイトル: All parents must converge

  有効にした場合、すべての親ノードがこのノードにアクセスするための基準を満たしている場合にのみノードが実行されます
• always_nodes: 配列 always_nodes
  読取り専用: true

  一意のアイテムが必要: true
• created: 文字列
  タイトル: Created

  読取り専用: true
• diff_mode: ブール
  タイトル: Diff mode
• execution_environment: 整数
  タイトル: Execution environment

  実行に使用されるコンテナ・イメージ。
• extra_data: オブジェクト Extra data
  タイトル: Extra data
• failure_nodes: 配列 failure_nodes
  読取り専用: true

  一意のアイテムが必要: true
• forks: 整数
  タイトル: Forks

  最小値: 0
• id: 整数
  タイトル: ID

  読取り専用: true
• identifier: 文字列
  タイトル: Identifier

  最小長: 1

  最大長: 512

  デフォルト値: 00000000-0000-0000-0000-000000000000

  そのワークフロー内で一意のこのノードの識別子。これはこのノードに対応するワークフロー・ジョブ・ノードにコピーされます。
• inventory: 整数
  タイトル: Inventory

  プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリのプロンプトが表示されると仮定する)
• job_slice_count: 整数
  タイトル: Job slice count

  最小値: 0
• job_tags: 文字列
  タイトル: Job tags
• job_type: 文字列
  タイトル: Job type

  指定できる値: [ "run", "check" ]
• limit: 文字列
  タイトル: Limit
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• related: 文字列
  タイトル: Related

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

  一意のアイテムが必要: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• timeout: 整数
  タイトル: Timeout
• type: 文字列
  タイトル: Type

  読取り専用: true
• unified_job_template: 整数
  タイトル: Unified job template
• url: 文字列
  タイトル: Url

  読取り専用: true
• verbosity: 文字列
  タイトル: Verbosity

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]
• workflow_job_template(必須): 文字列
  タイトル: Workflow job template

{
    "properties":{
        "all_parents_must_converge":{
            "description":"If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node",
            "title":"All parents must converge",
            "type":"boolean",
            "x-nullable":true
        },
        "always_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "failure_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "identifier":{
            "default":"00000000-0000-0000-0000-000000000000",
            "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.",
            "maxLength":"512",
            "minLength":"1",
            "title":"Identifier",
            "type":"string",
            "x-nullable":true
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "success_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "title":"Unified job template",
            "type":"integer",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        },
        "workflow_job_template":{
            "title":"Workflow job template",
            "type":"string"
        }
    },
    "required":[
        "workflow_job_template"
    ],
    "type":"object"
}

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

型: array

読取り専用: true

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

ソースを表示

• 配列: 整数

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

ネストされたスキーマ : Extra data

型: object

タイトル: Extra data

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

型: array

読取り専用: true

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

ソースを表示

• 配列: 整数

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

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

型: array

読取り専用: true

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

ソースを表示

• 配列: 整数

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

先頭に戻る