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

Retrieve a System Job

get

/api/v2/system_jobs/{id}/

Make GET request to this resource to retrieve a single system job record containing 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_args: (string)
  • job_cwd: (string)
  • job_env: (json)
  • 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)
  • result_traceback: (string)
  • event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)
  • 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)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "canceled_on":null,
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "elapsed":"0",
    "event_processing_finished":false,
    "execution_environment":null,
    "execution_node":"",
    "extra_vars":"",
    "failed":false,
    "finished":null,
    "id":"1",
    "job_args":"",
    "job_cwd":"",
    "job_env":{
    },
    "job_explanation":"",
    "job_type":"",
    "launch_type":"manual",
    "launched_by":{
    },
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"",
    "related":{
        "cancel":"/api/v2/system_jobs/1/cancel/",
        "events":"/api/v2/system_jobs/1/events/"
    },
    "result_stdout":"Standard Output too large to display (1048577 bytes), only download supported for sizes over 1048576 bytes.",
    "result_traceback":"",
    "started":null,
    "status":"new",
    "summary_fields":{
        "user_capabilities":{
            "delete":true,
            "start":false
        }
    },
    "system_job_template":null,
    "type":"system_job",
    "unified_job_template":null,
    "url":"/api/v2/system_jobs/1/",
    "work_unit_id":null
}
Back to Top