Oracle Linux Automation Manager CLI and API Reference Guide

List Notifications for a Workflow Job

get

/api/v2/workflow_jobs/{id}/notifications/

Make a GET request to this resource to retrieve a list of notifications associated with the selected workflow job.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of notifications found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more notification records.

Results

Each notification data structure includes 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)

Sorting

To specify that notifications are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme

Request

Supported Media Types

application/json

Path Parameters

id(required): string

Query Parameters

page: integer

A page number within the paginated result set.
page_size: integer

Number of results to return per page.
search: string

A search term.

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/Notification"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

Array of: object Notification

{
    "items":{
        "$ref":"#/definitions/Notification"
    },
    "type":"array"
}

Nested 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"
}