Oracle Linux Automation Manager CLI and API Reference Guide

Retrieve a Schedule

get

/api/v2/schedules/{id}/

Make GET request to this resource to retrieve a single schedule record containing the following fields:

rrule: A value representing the schedules iCal recurrence rule. (string)
id: Database ID for this schedule. (integer)
type: Data type for this schedule. (choice)
url: URL for this schedule. (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 schedule was created. (datetime)
modified: Timestamp when this schedule was last modified. (datetime)
name: Name of this schedule. (string)
description: Optional description of this schedule. (string)
extra_data: (json)
inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
scm_branch: (string)
job_type: (choice)
- None: ---------
- "": ---------
- run: Run
- check: Check
job_tags: (string)
skip_tags: (string)
limit: (string)
diff_mode: (boolean)
verbosity: (choice)
- None: ---------
- 0: 0 (Normal)
- 1: 1 (Verbose)
- 2: 2 (More Verbose)
- 3: 3 (Debug)
- 4: 4 (Connection Debug)
- 5: 5 (WinRM Debug)
execution_environment: The container image to be used for execution. (id)
forks: (integer)
job_slice_count: (integer)
timeout: (integer)
unified_job_template: (id)
enabled: Enables processing of this schedule. (boolean)
dtstart: The first occurrence of the schedule occurs on or after this time. (datetime)
dtend: The last occurrence of the schedule occurs before this time, aftewards the schedule expires. (datetime)
next_run: The next time that the scheduled action will run. (datetime)
timezone: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field. (field)
until: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned (field)

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Response

Supported Media Types

application/json

200 Response

Root Schema : Schedule

Type: object

Show Source

created: string

Title: Created

Read Only: true
description: string

Title: Description
diff_mode: boolean

Title: Diff mode
dtend: string(date-time)

Title: Dtend

Read Only: true

The last occurrence of the schedule occurs before this time, aftewards the schedule expires.
dtstart: string(date-time)

Title: Dtstart

Read Only: true

The first occurrence of the schedule occurs on or after this time.
enabled: boolean

Title: Enabled

Default Value: true

Enables processing of this schedule.
execution_environment: integer

Title: Execution environment

The container image to be used for execution.
extra_data: object Extra data

Title: Extra data
forks: integer

Title: Forks

Minimum Value: 0
id: integer

Title: ID

Read Only: true
inventory: integer

Title: Inventory

Inventory applied as a prompt, assuming job template prompts for inventory
job_slice_count: integer

Title: Job slice count

Minimum Value: 0
job_tags: string

Title: Job tags
job_type: string

Title: Job type

Allowed Values: [ "run", "check" ]
limit: string

Title: Limit
modified: string

Title: Modified

Read Only: true
name(required): string

Title: Name

Minimum Length: 1

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

Title: Next run

Read Only: true

The next time that the scheduled action will run.
related: string

Title: Related

Read Only: true
rrule(required): string

Title: Rrule

Minimum Length: 1

A value representing the schedules iCal recurrence rule.
scm_branch: string

Title: Scm branch
skip_tags: string

Title: Skip tags
summary_fields: string

Title: Summary fields

Read Only: true
timeout: integer

Title: Timeout
timezone: string

Title: Timezone

Read Only: true

The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.
type: string

Title: Type

Read Only: true
unified_job_template(required): integer

Title: Unified job template
until: string

Title: Until

Read Only: true

The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned
url: string

Title: Url

Read Only: true
verbosity: string

Title: Verbosity

Allowed Values: [ "0", "1", "2", "3", "4", "5" ]

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "dtend":{
            "description":"The last occurrence of the schedule occurs before this time, aftewards the schedule expires.",
            "format":"date-time",
            "readOnly":true,
            "title":"Dtend",
            "type":"string",
            "x-nullable":true
        },
        "dtstart":{
            "description":"The first occurrence of the schedule occurs on or after this time.",
            "format":"date-time",
            "readOnly":true,
            "title":"Dtstart",
            "type":"string",
            "x-nullable":true
        },
        "enabled":{
            "default":true,
            "description":"Enables processing of this schedule.",
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "title":"Limit",
            "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_run":{
            "description":"The next time that the scheduled action will run.",
            "format":"date-time",
            "readOnly":true,
            "title":"Next run",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "rrule":{
            "description":"A value representing the schedules iCal recurrence rule.",
            "minLength":"1",
            "title":"Rrule",
            "type":"string",
            "x-nullable":true
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "timezone":{
            "description":"The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.",
            "readOnly":true,
            "title":"Timezone",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "title":"Unified job template",
            "type":"integer"
        },
        "until":{
            "description":"The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned",
            "readOnly":true,
            "title":"Until",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "rrule",
        "name",
        "unified_job_template"
    ],
    "type":"object"
}

Nested Schema : Extra data

Type: object

Title: Extra data