1. Oracle Linux Automation Manager CLI and API Reference Guide
  2. Tasks
  3. Organizations

List Job Templates for an Organization

get

/api/v2/organizations/{id}/job_templates/

Make a GET request to this resource to retrieve a list of job templates associated with the selected organization.

The resulting data structure contains:

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

The count field indicates the total number of 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 job template records.

Results

Each job template data structure includes the following fields:

  • id: Database ID for this job template. (integer)
  • type: Data type for this job template. (choice)
  • url: URL for this 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 job template was created. (datetime)
  • modified: Timestamp when this job template was last modified. (datetime)
  • name: Name of this job template. (string)
  • description: Optional description of this job template. (string)
  • job_type: (choice)
    • run: Run
    • check: Check
  • inventory: (id)
  • project: (id)
  • playbook: (string)
  • scm_branch: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. (string)
  • forks: (integer)
  • limit: (string)
  • verbosity: (choice)
    • 0: 0 (Normal)
    • 1: 1 (Verbose)
    • 2: 2 (More Verbose)
    • 3: 3 (Debug)
    • 4: 4 (Connection Debug)
    • 5: 5 (WinRM Debug)
  • extra_vars: (json)
  • job_tags: (string)
  • force_handlers: (boolean)
  • skip_tags: (string)
  • start_at_task: (string)
  • timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
  • use_fact_cache: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. (boolean)
  • organization: The organization used to determine access to this template. (id)
  • 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
  • execution_environment: The container image to be used for execution. (id)
  • host_config_key: (string)
  • ask_scm_branch_on_launch: (boolean)
  • ask_diff_mode_on_launch: (boolean)
  • ask_variables_on_launch: (boolean)
  • ask_limit_on_launch: (boolean)
  • ask_tags_on_launch: (boolean)
  • ask_skip_tags_on_launch: (boolean)
  • ask_job_type_on_launch: (boolean)
  • ask_verbosity_on_launch: (boolean)
  • ask_inventory_on_launch: (boolean)
  • ask_credential_on_launch: (boolean)
  • ask_execution_environment_on_launch: (boolean)
  • ask_labels_on_launch: (boolean)
  • ask_forks_on_launch: (boolean)
  • ask_job_slice_count_on_launch: (boolean)
  • ask_timeout_on_launch: (boolean)
  • ask_instance_groups_on_launch: (boolean)
  • survey_enabled: (boolean)
  • become_enabled: (boolean)
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
  • allow_simultaneous: (boolean)
  • custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
  • job_slice_count: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. (integer)
  • 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)
  • prevent_instance_group_fallback: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. (boolean)

Sorting

To specify that 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

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : results
Type: array
Show Source
Nested Schema : JobTemplate
Type: object
Show Source
Back to Top