Notifications requests

Getting notifications

Gets a list of system and market level notifications. For a list of notifications, the API returns an array of LogEntryApiDTOs. Each LogEntryApiDTO will contain details about the notification, including the time, state, severity, and importance of the notification. To get a single notification, include the UUID of the notification in the request.

This request takes the following parameters:

  • start_time

    The start time for a historic range of notifications.

  • end_time

    The end time for a historic range of notifications.

  • category

    The category of notifications to return. [Discovery, Monitoring, Control, Mediation, Healthcheck, InterAppliance, MarketAction, MarketProblem, Presentation, Deploy, Security]

  • cursor

    When making subsequent calls to retrieve additional results, this is the cursor returned by the last call to this method.

  • limit

    The maximum number of items to return. Must be a positive integer. If not set, the server will provide a default (20).

  • order_by

    The field to order the results by. This value can be any field found in the response.

  • ascending

    Default: true. When false, results will be in descending order.

Examples:
  • All Notifications (no parameters): GET https://10.10.10.10/api/v3/notifications

  • All Notifications (parameters): GET https://10.10.10.10/api/v3/notifications?start_time=1237056032&end_time=1238056032&limit=100&order_by=name&ascending=true

  • Single Notification: GET https://10.10.10.10/api/v3/notifications/_5wcf4J5WEeinZ-6Uu4soUw

Response:

[
  {
    "links":[
      {
        "rel":"self",
        "href":"https://10.10.10.10/api/v3/notifications/_5wcf4J5WEeinZ-6Uu4soUw"
      }
    ],
    "uuid":"_5wcf4J5WEeinZ-6Uu4soUw",
    "logActionTime":1534095671518,
    "targetSE":"Hyper-V:hp-cluster.corp.mycorp.com",
    "category":"Discovery",
    "subCategory":"Validation",
    "description":"Validation of target hp-cluster.corp.mycorp.com failed",
    "shortDescription":"Validation Failed",
    "state":"NOTIFY",
    "severity":"MAJOR",
    "importance":0
  },
  {
    "links":[
      {
        "rel":"self",
        "href":"https://10.10.10.10/api/v3/notifications/_sQ7xUJ5XEeinZ-6Uu4soUw"
      }
    ],
    "uuid":"_sQ7xUJ5XEeinZ-6Uu4soUw",
    "logActionTime":1534096010470,
    "targetSE":"Hyper-V:hp-cluster.corp.mycorp.com",
    "category":"Discovery",
    "subCategory":"Discovery",
    "description":"Could not get domain for the 'hp-cluster.corp.mycorp.com' target",
    "shortDescription":"Discovery failed",
    "state":"NOTIFY",
    "severity":"MAJOR",
    "importance":0
  },
  ...
]