OpenManage Enterprise Version 3.3.1 and OpenManage Enterprise - Modular Edition Version 1.10.00 RESTful API Guide

PDF

GET method for AlertMessageDefinitions

This method returns the definitions for all alert messages.

Description

Returns the definitions for all alert messages.

Privilege

VIEW

HTTP response codes

200

Example response body

{
  "@odata.context": "$metadata#Collection(AlertService.AlertMessageDefinition)",
  "@odata.count": 3,
  "value": [
    {
      "@odata.id": "/api/AlertService/AlertMessageDefinitions('RAC9000')",
      "MessageId": "RAC9000",
      "Prefix": "RAC",
      "SequenceNo": 9000,
      "Message": "Device has become non compliant.",
      "RecommendedAction": "No response action is required.",
      "Severity": "Critical",
      "Category": "Configuration",
      "SubCategory": null,
      "DetailedDescription": "A device has become non compliant."
    },
    {
      "@odata.id": "/api/AlertService/AlertMessageDefinitions('LOG9000')",
      "MessageId": "LOG9000",
      "Prefix": "LOG",
      "SequenceNo": 9000,
      "Message": "Event definition not found for Event.",
      "RecommendedAction": "No response action is required.",
      "Severity": "Informational",
      "Category": "Configuration",
      "SubCategory": null,
      "DetailedDescription": "An unknwon event was received from a device."
    }
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
MessageId	ID of message definition.
Prefix	A 3-letter prefix of the message.
SequenceNo	Sequence number of the message.
Message	Message indicating the issue.
RecommendedAction	Recommended action for the message.
Severity	Type of severity.
Category	Category associated to the message.
SubCategory	Subcategory associated with the message.
DetailedDescription	Detailed description of the issue.