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
• webhook_credential: Personal Access Token for posting back the status to the service API (id)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Query Parameters

• search: string
  A search term.

Back to Top

Response

200 Response

Back to Top