Oracle Linux Automation Manager CLI and API Reference Guide

Retrieve a System Job Template

get

/api/v2/system_job_templates/{id}/

Make GET request to this resource to retrieve a single system job template record containing the following fields:

id: Database ID for this system job template. (integer)
type: Data type for this system job template. (choice)
url: URL for this system 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 system job template was created. (datetime)
modified: Timestamp when this system job template was last modified. (datetime)
name: Name of this system job template. (string)
description: Optional description of this system job template. (string)
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
- ok: OK
- missing: Missing
- none: No External Source
- updating: Updating
execution_environment: The container image to be used for execution. (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

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Response

Supported Media Types

application/json

200 Response

Root Schema : SystemJobTemplate

Type: object

Show Source

created: string

Title: Created

Read Only: true
description: string

Title: Description
execution_environment: integer

Title: Execution environment

The container image to be used for execution.
id: integer

Title: ID

Read Only: true
job_type: string

Title: Job type

Allowed Values: [ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ]
last_job_failed: boolean

Title: Last job failed

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

Title: Last job run

Read Only: true
modified: string

Title: Modified

Read Only: true
name(required): string

Title: Name

Minimum Length: 1

Maximum Length: 512
next_job_run: string(date-time)

Title: Next job run

Read Only: true
related: string

Title: Related

Read Only: true
status: string

Title: Status

Read Only: true

Allowed Values: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
summary_fields: string

Title: Summary fields

Read Only: true
type: string

Title: Type

Read Only: true
url: string

Title: Url

Read Only: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "job_type":{
            "enum":[
                "cleanup_jobs",
                "cleanup_activitystream",
                "cleanup_sessions",
                "cleanup_tokens"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "ok",
                "missing",
                "none",
                "updating"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}