1. Oracle Linux Automation Manager CLI and API Reference Guide 2.1
  2. Tasks
  3. Unified Jobs

List Unified Jobs

get

/api/v2/unified_jobs/

Make a GET request to this resource to retrieve the list of unified jobs.

The resulting data structure contains:

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

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

Results

Each unified job data structure includes the following fields:

  • id: Database ID for this unified job. (integer)
  • type: Data type for this unified job. (choice)
  • url: URL for this unified 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 unified job was created. (datetime)
  • modified: Timestamp when this unified job was last modified. (datetime)
  • name: Name of this unified job. (string)
  • description: Optional description of this unified 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)

Sorting

To specify that unified 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 Oracle Linux Automation Manaer) Search across related fields:

?related__search=findme

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "count":"1",
    "next":null,
    "previous":null,
    "results":[
        {
            "allow_simultaneous":false,
            "artifacts":{
            },
            "canceled_on":null,
            "controller_node":"",
            "created":"2018-02-01T08:00:00.000000Z",
            "description":"",
            "diff_mode":false,
            "elapsed":"0",
            "execution_environment":null,
            "execution_node":"",
            "extra_vars":"{}",
            "failed":false,
            "finished":null,
            "force_handlers":false,
            "forks":"0",
            "id":"1",
            "instance_group":null,
            "inventory":null,
            "job_explanation":"",
            "job_slice_count":"1",
            "job_slice_number":"0",
            "job_tags":"",
            "job_template":"1",
            "job_type":"run",
            "launch_type":"manual",
            "launched_by":{
            },
            "limit":"",
            "modified":"2018-02-01T08:00:00.000000Z",
            "name":"",
            "organization":null,
            "passwords_needed_to_start":[
            ],
            "playbook":"",
            "project":null,
            "related":{
                "activity_stream":"/api/v2/jobs/1/activity_stream/",
                "cancel":"/api/v2/jobs/1/cancel/",
                "create_schedule":"/api/v2/jobs/1/create_schedule/",
                "credentials":"/api/v2/jobs/1/credentials/",
                "job_events":"/api/v2/jobs/1/job_events/",
                "job_host_summaries":"/api/v2/jobs/1/job_host_summaries/",
                "job_template":"/api/v2/job_templates/1/",
                "labels":"/api/v2/jobs/1/labels/",
                "notifications":"/api/v2/jobs/1/notifications/",
                "relaunch":"/api/v2/jobs/1/relaunch/",
                "stdout":"/api/v2/jobs/1/stdout/",
                "unified_job_template":"/api/v2/job_templates/1/"
            },
            "scm_branch":"",
            "scm_revision":"",
            "skip_tags":"",
            "start_at_task":"",
            "started":null,
            "status":"new",
            "summary_fields":{
                "credentials":[
                ],
                "job_template":{
                    "description":"",
                    "id":"1",
                    "name":""
                },
                "labels":{
                    "count":"0",
                    "results":[
                    ]
                },
                "unified_job_template":{
                    "description":"",
                    "id":"1",
                    "name":"",
                    "unified_job_type":"job"
                },
                "user_capabilities":{
                    "delete":true,
                    "start":false
                }
            },
            "timeout":"0",
            "type":"job",
            "unified_job_template":"1",
            "url":"/api/v2/jobs/1/",
            "use_fact_cache":false,
            "verbosity":"0",
            "webhook_credential":null,
            "webhook_guid":"",
            "webhook_service":"",
            "work_unit_id":null
        }
    ]
}
Back to Top