Oracle Linux Automation Manager CLI and API Reference Guide

List System Jobs for a System Job Template

get

/api/v2/system_job_templates/{id}/jobs/

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

The resulting data structure contains:

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

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

Results

Each system job data structure includes the following fields:

id: Database ID for this system job. (integer)
type: Data type for this system job. (choice)
url: URL for this system 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 system job was created. (datetime)
modified: Timestamp when this system job was last modified. (datetime)
name: Name of this system job. (string)
description: Optional description of this system 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)
launched_by: (field)
work_unit_id: The Receptor work unit ID associated with this job. (string)
system_job_template: (id)
job_type: (choice)
- "": ---------
- cleanup_jobs: Remove jobs older than a certain number of days
- cleanup_activitystream: Remove activity stream entries older than a certain number of days
- cleanup_sessions: Removes expired browser sessions from the database
- cleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokens
extra_vars: (string)
result_stdout: (field)

Sorting

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

application/json

Path Parameters

id(required): string

Query Parameters

page: integer

A page number within the paginated result set.
page_size: integer

Number of results to return per page.
search: string

A search term.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/SystemJobList"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

Array of: object SystemJobList

{
    "items":{
        "$ref":"#/definitions/SystemJobList"
    },
    "type":"array"
}

Nested Schema : SystemJobList

Type: object

Show Source

canceled_on: string(date-time)

Title: Canceled on

Read Only: true

The date and time when the cancel request was sent.
created: string

Title: Created

Read Only: true
description: string

Title: Description
elapsed: string(decimal)

Title: Elapsed

Read Only: true

Elapsed time in seconds that the job ran.
execution_environment: integer

Title: Execution environment

The container image to be used for execution.
execution_node: string

Title: Execution node

Read Only: true

Minimum Length: 1

The node the job executed on.
extra_vars: string

Title: Extra vars
failed: boolean

Title: Failed

Read Only: true
finished: string(date-time)

Title: Finished

Read Only: true

The date and time the job finished execution.
id: integer

Title: ID

Read Only: true
job_explanation: string

Title: Job explanation

Read Only: true

Minimum Length: 1

A status field to indicate the state of the job if it wasn't able to run and capture stdout
job_type: string

Title: Job type

Allowed Values: [ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ]
launch_type: string

Title: Launch type

Read Only: true

Allowed Values: [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
launched_by: string

Title: Launched by

Read Only: true
modified: string

Title: Modified

Read Only: true
name(required): string

Title: Name

Minimum Length: 1

Maximum Length: 512
related: string

Title: Related

Read Only: true
result_stdout: string

Title: Result stdout

Read Only: true
started: string(date-time)

Title: Started

Read Only: true

The date and time the job was queued for starting.
status: string

Title: Status

Read Only: true

Allowed Values: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
summary_fields: string

Title: Summary fields

Read Only: true
system_job_template: string

Title: System job template
type: string

Title: Type

Read Only: true
unified_job_template: string

Title: unified job template

Read Only: true
url: string

Title: Url

Read Only: true
work_unit_id: string

Title: Work unit id

Read Only: true

Minimum Length: 1

The Receptor work unit ID associated with this job.

{
    "properties":{
        "canceled_on":{
            "description":"The date and time when the cancel request was sent.",
            "format":"date-time",
            "readOnly":true,
            "title":"Canceled on",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "execution_node":{
            "description":"The node the job executed on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Execution node",
            "type":"string"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "finished":{
            "description":"The date and time the job finished execution.",
            "format":"date-time",
            "readOnly":true,
            "title":"Finished",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "job_explanation":{
            "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout",
            "minLength":"1",
            "readOnly":true,
            "title":"Job explanation",
            "type":"string"
        },
        "job_type":{
            "enum":[
                "cleanup_jobs",
                "cleanup_activitystream",
                "cleanup_sessions",
                "cleanup_tokens"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "launch_type":{
            "enum":[
                "manual",
                "relaunch",
                "callback",
                "scheduled",
                "dependency",
                "workflow",
                "webhook",
                "sync",
                "scm"
            ],
            "readOnly":true,
            "title":"Launch type",
            "type":"string"
        },
        "launched_by":{
            "readOnly":true,
            "title":"Launched by",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_stdout":{
            "readOnly":true,
            "title":"Result stdout",
            "type":"string"
        },
        "started":{
            "description":"The date and time the job was queued for starting.",
            "format":"date-time",
            "readOnly":true,
            "title":"Started",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "system_job_template":{
            "title":"System job template",
            "type":"string",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "readOnly":true,
            "title":"unified job template",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "work_unit_id":{
            "description":"The Receptor work unit ID associated with this job.",
            "minLength":"1",
            "readOnly":true,
            "title":"Work unit id",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}