Jump to

• Request
• Response

Retrieve a Workflow Job Template

get

/api/v2/workflow_job_templates/{id}/

Make GET request to this resource to retrieve a single workflow job template record containing the following fields:

• id: Database ID for this workflow job template. (integer)
• type: Data type for this workflow job template. (choice)
• url: URL for this workflow job template. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this workflow job template was created. (datetime)
• modified: Timestamp when this workflow job template was last modified. (datetime)
• name: Name of this workflow job template. (string)
• description: Optional description of this workflow job template. (string)
• last_job_run: (datetime)
• last_job_failed: (boolean)
• next_job_run: (datetime)
• status: (choice)
  • new: New
  • pending: Pending
  • waiting: Waiting
  • running: Running
  • successful: Successful
  • failed: Failed
  • error: Error
  • canceled: Canceled
  • never updated: Never Updated
  • ok: OK
  • missing: Missing
  • none: No External Source
  • updating: Updating
• extra_vars: (json)
• organization: The organization used to determine access to this template. (id)
• survey_enabled: (boolean)
• allow_simultaneous: (boolean)
• ask_variables_on_launch: (boolean)
• inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
• limit: (string)
• scm_branch: (string)
• ask_inventory_on_launch: (boolean)
• ask_scm_branch_on_launch: (boolean)
• ask_limit_on_launch: (boolean)
• webhook_service: Service that webhook requests will be accepted from (choice)
  • "": ---------
  • github: GitHub
  • gitlab: GitLab
  • bitbucket_dc: BitBucket DataCenter
• webhook_credential: Personal Access Token for posting back the status to the service API (id)
• ask_labels_on_launch: (boolean)
• ask_skip_tags_on_launch: (boolean)
• ask_tags_on_launch: (boolean)
• skip_tags: (string)
• job_tags: (string)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : WorkflowJobTemplate

Type: object

Show Source

• allow_simultaneous: boolean
  Title: Allow simultaneous
• ask_inventory_on_launch: boolean
  Title: Ask inventory on launch
• ask_labels_on_launch: boolean
  Title: Ask labels on launch
• ask_limit_on_launch: boolean
  Title: Ask limit on launch
• ask_scm_branch_on_launch: boolean
  Title: Ask scm branch on launch
• ask_skip_tags_on_launch: boolean
  Title: Ask skip tags on launch
• ask_tags_on_launch: boolean
  Title: Ask tags on launch
• ask_variables_on_launch: boolean
  Title: Ask variables on launch
• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• extra_vars: string
  Title: Extra vars
• id: integer
  Title: ID

  Read Only: true
• inventory: integer
  Title: Inventory

  Inventory applied as a prompt, assuming job template prompts for inventory
• job_tags: string
  Title: Job tags
• last_job_failed: boolean
  Title: Last job failed

  Read Only: true
• last_job_run: string(date-time)
  Title: Last job run

  Read Only: true
• limit: string
  Title: Limit
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• next_job_run: string(date-time)
  Title: Next job run

  Read Only: true
• organization: integer
  Title: Organization

  The organization used to determine access to this template.
• related: string
  Title: Related

  Read Only: true
• scm_branch: string
  Title: Scm branch
• skip_tags: string
  Title: Skip tags
• status: string
  Title: Status

  Read Only: true

  Allowed Values: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
• summary_fields: string
  Title: Summary fields

  Read Only: true
• survey_enabled: boolean
  Title: Survey enabled
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• webhook_credential: integer
  Title: Webhook credential

  Personal Access Token for posting back the status to the service API
• webhook_service: string
  Title: Webhook service

  Allowed Values: [ "github", "gitlab", "bitbucket_dc" ]

  Service that webhook requests will be accepted from

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "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
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "ok",
                "missing",
                "none",
                "updating"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "survey_enabled":{
            "title":"Survey enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "title":"Webhook credential",
            "type":"integer",
            "x-nullable":true
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "enum":[
                "github",
                "gitlab",
                "bitbucket_dc"
            ],
            "title":"Webhook service",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Back to Top