Make a GET request to this resource to retrieve the list of workflow job templates.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of workflow job templates found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more workflow job template records.

Results

Each workflow job template data structure includes 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)

Sorting

To specify that workflow job templates are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme