Oracle Linux Automation Manager CLI and API Reference Guide

Retrieve a Notification

get

/api/v2/notifications/{id}/

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

id: Database ID for this notification. (integer)
type: Data type for this notification. (choice)
url: URL for this notification. (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 notification was created. (datetime)
modified: Timestamp when this notification was last modified. (datetime)
notification_template: (id)
error: (string)
status: (choice)
- pending: Pending
- successful: Successful
- failed: Failed
notifications_sent: (integer)
notification_type: (choice)
- email: Email
- grafana: Grafana
- irc: IRC
- mattermost: Mattermost
- pagerduty: Pagerduty
- rocketchat: Rocket.Chat
- slack: Slack
- twilio: Twilio
- webhook: Webhook
recipients: (string)
subject: (string)
body: Notification body (json)

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Response

Supported Media Types

application/json

200 Response

Root Schema : Notification

Type: object

Show Source

body: string

Title: Body

Read Only: true

Notification body
created: string

Title: Created

Read Only: true
error: string

Title: Error

Read Only: true

Minimum Length: 1
id: integer

Title: ID

Read Only: true
modified: string

Title: Modified

Read Only: true
notification_template: integer

Title: Notification template

Read Only: true
notification_type(required): string

Title: Notification type

Allowed Values: [ "email", "grafana", "irc", "mattermost", "pagerduty", "rocketchat", "slack", "twilio", "webhook" ]
notifications_sent: integer

Title: Notifications sent

Read Only: true
recipients: string

Title: Recipients

Read Only: true

Minimum Length: 1
related: string

Title: Related

Read Only: true
status: string

Title: Status

Read Only: true

Allowed Values: [ "pending", "successful", "failed" ]
subject: string

Title: Subject

Read Only: true

Minimum Length: 1
summary_fields: string

Title: Summary fields

Read Only: true
type: string

Title: Type

Read Only: true
url: string

Title: Url

Read Only: true

{
    "properties":{
        "body":{
            "description":"Notification body",
            "readOnly":true,
            "title":"Body",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "error":{
            "minLength":"1",
            "readOnly":true,
            "title":"Error",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "notification_template":{
            "readOnly":true,
            "title":"Notification template",
            "type":"integer"
        },
        "notification_type":{
            "enum":[
                "email",
                "grafana",
                "irc",
                "mattermost",
                "pagerduty",
                "rocketchat",
                "slack",
                "twilio",
                "webhook"
            ],
            "title":"Notification type",
            "type":"string",
            "x-nullable":true
        },
        "notifications_sent":{
            "readOnly":true,
            "title":"Notifications sent",
            "type":"integer"
        },
        "recipients":{
            "minLength":"1",
            "readOnly":true,
            "title":"Recipients",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "status":{
            "enum":[
                "pending",
                "successful",
                "failed"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "subject":{
            "minLength":"1",
            "readOnly":true,
            "title":"Subject",
            "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":[
        "notification_type"
    ],
    "type":"object"
}