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

List Jobs for a Job Template

get

/api/v2/job_templates/{id}/jobs/

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

The resulting data structure contains:

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

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

Results

Each job data structure includes the following fields:

  • id: Database ID for this job. (integer)
  • type: Data type for this job. (choice)
  • url: URL for this job. (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 was created. (datetime)
  • modified: Timestamp when this job was last modified. (datetime)
  • name: Name of this job. (string)
  • description: Optional description of this job. (string)
  • unified_job_template: (id)
  • launch_type: (choice)
    • manual: Manual
    • relaunch: Relaunch
    • callback: Callback
    • scheduled: Scheduled
    • dependency: Dependency
    • workflow: Workflow
    • webhook: Webhook
    • sync: Sync
    • scm: SCM Update
  • status: (choice)
    • new: New
    • pending: Pending
    • waiting: Waiting
    • running: Running
    • successful: Successful
    • failed: Failed
    • error: Error
    • canceled: Canceled
  • execution_environment: The container image to be used for execution. (id)
  • failed: (boolean)
  • started: The date and time the job was queued for starting. (datetime)
  • finished: The date and time the job finished execution. (datetime)
  • canceled_on: The date and time when the cancel request was sent. (datetime)
  • elapsed: Elapsed time in seconds that the job ran. (decimal)
  • job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
  • execution_node: The node the job executed on. (string)
  • controller_node: The instance that managed the execution environment. (string)
  • launched_by: (field)
  • work_unit_id: The Receptor work unit ID associated with this job. (string)
  • job_type: (choice)
    • run: Run
    • check: Check
    • scan: Scan
  • 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 unified job. (id)
  • job_template: (id)
  • passwords_needed_to_start: (field)
  • allow_simultaneous: (boolean)
  • artifacts: (json)
  • scm_revision: The SCM Revision from the Project used for this job, if available (string)
  • instance_group: The Instance group the job was run under (id)
  • diff_mode: If enabled, textual changes made to any templated files on the host are shown in the standard output (boolean)
  • job_slice_number: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used. (integer)
  • job_slice_count: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job. (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)
  • webhook_guid: Unique identifier of the event that triggered this webhook (string)

Sorting

To specify that jobs 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 : JobList
Type: object
Show Source
Back to Top