Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET settings/notification/alarmCategories

Retrieves current alarms notification settings

Since Product Version: 3.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Credential

HTTP Methods

GET

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

/webacs/api/v1/op/settings/notification/alarmCategories

Response Parameters

Attribute Description

alarmCategoriesSettings Arrow image AlarmCategoryNotificationSettingsDTO[]

Array of notification settings per alarm category (at least one category is required)

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Response Payload

https://10.64.80.159/webacs/api/v1/op/settings/notification/alarmCategories

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v1/op">
  <alarmsNotificationSettingsDTO>
    <alarmCategoriesSettings>
      <alarmCategoriesSettings>
        <categoryName>String value</categoryName>
        <includeCritical>true</includeCritical>
        <includeMajor>true</includeMajor>
        <includeMinor>true</includeMinor>
        <includeWarning>true</includeWarning>
        <isNotificationEnabled>true</isNotificationEnabled>
        <toAddress>String value</toAddress>
      </alarmCategoriesSettings>
      <alarmCategoriesSettings>
        <categoryName>Another string value</categoryName>
        <includeCritical>false</includeCritical>
        <includeMajor>false</includeMajor>
        <includeMinor>false</includeMinor>
        <includeWarning>false</includeWarning>
        <isNotificationEnabled>false</isNotificationEnabled>
        <toAddress>Another string value</toAddress>
      </alarmCategoriesSettings>
    </alarmCategoriesSettings>
  </alarmsNotificationSettingsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.64.80.159/webacs/api/v1/op/settings/notification/alarmCategories.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/op\/settings\/notification\/alarmCategories",
    "@rootUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/op",
    "alarmsNotificationSettingsDTO" : {
      "alarmCategoriesSettings" : {
        "alarmCategoriesSettings" : [{
          "categoryName" : "String value",
          "includeCritical" : true,
          "includeMajor" : true,
          "includeMinor" : true,
          "includeWarning" : true,
          "isNotificationEnabled" : true,
          "toAddress" : "String value"
        },
        {
          "categoryName" : "Another string value",
          "includeCritical" : false,
          "includeMajor" : false,
          "includeMinor" : false,
          "includeWarning" : false,
          "isNotificationEnabled" : false,
          "toAddress" : "Another string value"
        }]
      }
    }
  }
}