1. Oracle Linux Automation Manager CLI and API Reference Guide 2.1
  2. Tasks
  3. Workflow Job Templates

Update a Workflow Job Template

patch

/api/v2/workflow_job_templates/{id}/

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

  • name: Name of this workflow job template. (string, required)

  • description: Optional description of this workflow job template. (string, default="")

  • extra_vars: (json, default=``)

  • organization: The organization used to determine access to this template. (id, default=``)
  • survey_enabled: (boolean, default=False)
  • allow_simultaneous: (boolean, default=False)
  • ask_variables_on_launch: (boolean, default=False)
  • inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id, default=``)
  • limit: (string, default="")
  • scm_branch: (string, default="")
  • ask_inventory_on_launch: (boolean, default=False)
  • ask_scm_branch_on_launch: (boolean, default=False)
  • ask_limit_on_launch: (boolean, default=False)
  • webhook_service: Service that webhook requests will be accepted from (choice)
    • "": ---------
    • github: GitHub
    • gitlab: GitLab
  • webhook_credential: Personal Access Token for posting back the status to the service API (id, default=``)

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

Request

Supported Media Types
Path Parameters
Query Parameters
Body ()
Root Schema : schema
Example:
{
    "name":"foooooo"
}
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "allow_simultaneous":false,
    "ask_inventory_on_launch":false,
    "ask_limit_on_launch":false,
    "ask_scm_branch_on_launch":false,
    "ask_variables_on_launch":false,
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "extra_vars":"",
    "id":"1",
    "inventory":null,
    "last_job_failed":false,
    "last_job_run":null,
    "limit":null,
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"foooooo",
    "next_job_run":null,
    "organization":"1",
    "related":{
        "access_list":"/api/v2/workflow_job_templates/1/access_list/",
        "activity_stream":"/api/v2/workflow_job_templates/1/activity_stream/",
        "copy":"/api/v2/workflow_job_templates/1/copy/",
        "labels":"/api/v2/workflow_job_templates/1/labels/",
        "launch":"/api/v2/workflow_job_templates/1/launch/",
        "notification_templates_approvals":"/api/v2/workflow_job_templates/1/notification_templates_approvals/",
        "notification_templates_error":"/api/v2/workflow_job_templates/1/notification_templates_error/",
        "notification_templates_started":"/api/v2/workflow_job_templates/1/notification_templates_started/",
        "notification_templates_success":"/api/v2/workflow_job_templates/1/notification_templates_success/",
        "object_roles":"/api/v2/workflow_job_templates/1/object_roles/",
        "organization":"/api/v2/organizations/1/",
        "schedules":"/api/v2/workflow_job_templates/1/schedules/",
        "survey_spec":"/api/v2/workflow_job_templates/1/survey_spec/",
        "webhook_key":"/api/v2/workflow_job_templates/1/webhook_key/",
        "webhook_receiver":"",
        "workflow_jobs":"/api/v2/workflow_job_templates/1/workflow_jobs/",
        "workflow_nodes":"/api/v2/workflow_job_templates/1/workflow_nodes/"
    },
    "scm_branch":null,
    "status":"never updated",
    "summary_fields":{
        "labels":{
            "count":"0",
            "results":[
            ]
        },
        "object_roles":{
            "admin_role":{
                "description":"Can manage all aspects of the workflow job template",
                "id":"16",
                "name":"Admin"
            },
            "approval_role":{
                "description":"Can approve or deny a workflow approval node",
                "id":"19",
                "name":"Approve"
            },
            "execute_role":{
                "description":"May run the workflow job template",
                "id":"17",
                "name":"Execute"
            },
            "read_role":{
                "description":"May view settings for the workflow job template",
                "id":"18",
                "name":"Read"
            }
        },
        "organization":{
            "description":"test-org-desc",
            "id":"1",
            "name":"test-org"
        },
        "recent_jobs":[
        ],
        "user_capabilities":{
            "copy":true,
            "delete":true,
            "edit":true,
            "schedule":true,
            "start":true
        }
    },
    "survey_enabled":false,
    "type":"workflow_job_template",
    "url":"/api/v2/workflow_job_templates/1/",
    "webhook_credential":null,
    "webhook_service":""
}
Back to Top