Oracle Linux Automation Manager CLI and API Reference Guide

Retrieve a Job Event

get

/api/v2/job_events/{id}/

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

id: Database ID for this job event. (integer)
type: Data type for this job event. (choice)
url: URL for this job event. (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 job event was created. (datetime)
modified: Timestamp when this job event was last modified. (datetime)
job: (id)
event: (choice)
- runner_on_failed: Host Failed
- runner_on_start: Host Started
- runner_on_ok: Host OK
- runner_on_error: Host Failure
- runner_on_skipped: Host Skipped
- runner_on_unreachable: Host Unreachable
- runner_on_no_hosts: No Hosts Remaining
- runner_on_async_poll: Host Polling
- runner_on_async_ok: Host Async OK
- runner_on_async_failed: Host Async Failure
- runner_item_on_ok: Item OK
- runner_item_on_failed: Item Failed
- runner_item_on_skipped: Item Skipped
- runner_retry: Host Retry
- runner_on_file_diff: File Difference
- playbook_on_start: Playbook Started
- playbook_on_notify: Running Handlers
- playbook_on_include: Including File
- playbook_on_no_hosts_matched: No Hosts Matched
- playbook_on_no_hosts_remaining: No Hosts Remaining
- playbook_on_task_start: Task Started
- playbook_on_vars_prompt: Variables Prompted
- playbook_on_setup: Gathering Facts
- playbook_on_import_for_host: internal: on Import for Host
- playbook_on_not_import_for_host: internal: on Not Import for Host
- playbook_on_play_start: Play Started
- playbook_on_stats: Playbook Complete
- debug: Debug
- verbose: Verbose
- deprecated: Deprecated
- warning: Warning
- system_warning: System Warning
- error: Error
counter: (integer)
event_display: (string)
event_data: (json)
event_level: (integer)
failed: (boolean)
changed: (boolean)
uuid: (string)
parent_uuid: (string)
host: (id)
host_name: (string)
playbook: (string)
play: (string)
task: (string)
role: (string)
stdout: (string)
start_line: (integer)
end_line: (integer)
verbosity: (integer)

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Response

Supported Media Types

application/json

200 Response

Root Schema : JobEvent

Type: object

Show Source

changed: boolean

Title: Changed

Read Only: true
counter: integer

Title: Counter

Read Only: true

Minimum Value: 0
created: string

Title: Created

Read Only: true
end_line: integer

Title: End line

Read Only: true

Minimum Value: 0
event(required): string

Title: Event

Allowed Values: [ "runner_on_failed", "runner_on_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error" ]
event_data: object Event data

Title: Event data
event_display: string

Title: Event display

Read Only: true

Minimum Length: 1
event_level: integer

Title: Event level

Read Only: true
failed: boolean

Title: Failed

Read Only: true
host: integer

Title: Host

Read Only: true
host_name: string

Title: Host name

Read Only: true

Minimum Length: 1
id: integer

Title: ID

Read Only: true
job: string

Title: Job

Read Only: true
modified: string

Title: Modified

Read Only: true
parent_uuid: string

Title: Parent uuid

Read Only: true

Minimum Length: 1
play: string

Title: Play

Read Only: true

Minimum Length: 1
playbook: string

Title: Playbook

Read Only: true

Minimum Length: 1
related: string

Title: Related

Read Only: true
role: string

Title: Role

Read Only: true

Minimum Length: 1
start_line: integer

Title: Start line

Read Only: true

Minimum Value: 0
stdout: string

Title: Stdout

Read Only: true

Minimum Length: 1
summary_fields: string

Title: Summary fields

Read Only: true
task: string

Title: Task

Read Only: true

Minimum Length: 1
type: string

Title: Type

Read Only: true
url: string

Title: Url

Read Only: true
uuid: string

Title: Uuid

Read Only: true

Minimum Length: 1
verbosity: integer

Title: Verbosity

Read Only: true

Minimum Value: 0

{
    "properties":{
        "changed":{
            "readOnly":true,
            "title":"Changed",
            "type":"boolean"
        },
        "counter":{
            "minimum":"0",
            "readOnly":true,
            "title":"Counter",
            "type":"integer"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "end_line":{
            "minimum":"0",
            "readOnly":true,
            "title":"End line",
            "type":"integer"
        },
        "event":{
            "enum":[
                "runner_on_failed",
                "runner_on_start",
                "runner_on_ok",
                "runner_on_error",
                "runner_on_skipped",
                "runner_on_unreachable",
                "runner_on_no_hosts",
                "runner_on_async_poll",
                "runner_on_async_ok",
                "runner_on_async_failed",
                "runner_item_on_ok",
                "runner_item_on_failed",
                "runner_item_on_skipped",
                "runner_retry",
                "runner_on_file_diff",
                "playbook_on_start",
                "playbook_on_notify",
                "playbook_on_include",
                "playbook_on_no_hosts_matched",
                "playbook_on_no_hosts_remaining",
                "playbook_on_task_start",
                "playbook_on_vars_prompt",
                "playbook_on_setup",
                "playbook_on_import_for_host",
                "playbook_on_not_import_for_host",
                "playbook_on_play_start",
                "playbook_on_stats",
                "debug",
                "verbose",
                "deprecated",
                "warning",
                "system_warning",
                "error"
            ],
            "title":"Event",
            "type":"string",
            "x-nullable":true
        },
        "event_data":{
            "title":"Event data",
            "type":"object"
        },
        "event_display":{
            "minLength":"1",
            "readOnly":true,
            "title":"Event display",
            "type":"string"
        },
        "event_level":{
            "readOnly":true,
            "title":"Event level",
            "type":"integer"
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "host":{
            "readOnly":true,
            "title":"Host",
            "type":"integer",
            "x-nullable":true
        },
        "host_name":{
            "minLength":"1",
            "readOnly":true,
            "title":"Host name",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "job":{
            "readOnly":true,
            "title":"Job",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "parent_uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Parent uuid",
            "type":"string"
        },
        "play":{
            "minLength":"1",
            "readOnly":true,
            "title":"Play",
            "type":"string"
        },
        "playbook":{
            "minLength":"1",
            "readOnly":true,
            "title":"Playbook",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "role":{
            "minLength":"1",
            "readOnly":true,
            "title":"Role",
            "type":"string"
        },
        "start_line":{
            "minimum":"0",
            "readOnly":true,
            "title":"Start line",
            "type":"integer"
        },
        "stdout":{
            "minLength":"1",
            "readOnly":true,
            "title":"Stdout",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "task":{
            "minLength":"1",
            "readOnly":true,
            "title":"Task",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Uuid",
            "type":"string"
        },
        "verbosity":{
            "minimum":"0",
            "readOnly":true,
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "required":[
        "event"
    ],
    "type":"object"
}

Nested Schema : Event data

Type: object

Title: Event data