Jump to

• Request
• Response

Update a Workflow Job Template Node

patch

/api/v2/workflow_job_template_nodes/{id}/

Make a PUT or PATCH request to this resource to update this workflow job template node. The following fields may be modified:

• extra_data: (json, default={})
• inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
• scm_branch: (string, default="")
• job_type: (choice)
  • None: --------- (default)
  • "": ---------
  • run: Run
  • check: Check
• job_tags: (string, default="")
• skip_tags: (string, default="")
• limit: (string, default="")
• diff_mode: (boolean, default=None)
• verbosity: (choice)
  • None: --------- (default)
  • 0: 0 (Normal)
  • 1: 1 (Verbose)
  • 2: 2 (More Verbose)
  • 3: 3 (Debug)
  • 4: 4 (Connection Debug)
  • 5: 5 (WinRM Debug)
• workflow_job_template: (id, required)

• unified_job_template: (id, default=``)

• all_parents_must_converge: If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node (boolean, default=False)

• identifier: An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node. (string, default="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")

For a PATCH request, include only the fields that are being modified.

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Query Parameters

• search(optional): string
  A search term.

Body ()

Root Schema : schema

Type: object

Show Source

• all_parents_must_converge(optional): boolean
  If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node
• diff_mode(optional): boolean
• extra_data(optional): string
• identifier(optional): string
  An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.
• inventory(optional): integer
  Inventory applied as a prompt, assuming job template prompts for inventory
• job_tags(optional): string
• job_type(optional): string
• limit(optional): string
• scm_branch(optional): string
• skip_tags(optional): string
• unified_job_template(optional): integer
• verbosity(optional): string
• workflow_job_template(optional): string

{
    "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",
            "type":"boolean"
        },
        "diff_mode":{
            "description":"",
            "type":"boolean"
        },
        "extra_data":{
            "description":"",
            "type":"string"
        },
        "identifier":{
            "description":"An identifier for this node that is unique within its workflow. It is copied to workflow job nodes corresponding to this node.",
            "type":"string"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "type":"integer"
        },
        "job_tags":{
            "description":"",
            "type":"string"
        },
        "job_type":{
            "description":"",
            "type":"string"
        },
        "limit":{
            "description":"",
            "type":"string"
        },
        "scm_branch":{
            "description":"",
            "type":"string"
        },
        "skip_tags":{
            "description":"",
            "type":"string"
        },
        "unified_job_template":{
            "description":"",
            "type":"integer"
        },
        "verbosity":{
            "description":"",
            "type":"string"
        },
        "workflow_job_template":{
            "description":"",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

200 Response

Back to Top