Retrieves current alarms notification settings
Since Product Version: 3.2
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Compliance Service (5)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
- v4
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 |
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/alarmCategoriesResponse Parameters
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://localhost/webacs/api/v1/op/settings/notification/alarmCategories
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/settings/notification/alarmCategories" rootUrl="https://localhost/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>
</alarmsNotificationSettingsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/settings/notification/alarmCategories.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/settings\/notification\/alarmCategories",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"alarmsNotificationSettingsDTO" : {
"alarmCategoriesSettings" : {
"alarmCategoriesSettings" : {
"categoryName" : "String value",
"includeCritical" : true,
"includeMajor" : true,
"includeMinor" : true,
"includeWarning" : true,
"isNotificationEnabled" : true,
"toAddress" : "String value"
}
}
}
}
}
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 |
Resource URL
/webacs/api/v2/op/settings/notification/alarmCategories UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alarmCategoriesSettings
|
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://localhost/webacs/api/v2/op/settings/notification/alarmCategories
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/settings/notification/alarmCategories" rootUrl="https://localhost/webacs/api/v2/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>
</alarmsNotificationSettingsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/settings/notification/alarmCategories.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/settings/notification/alarmCategories",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"alarmsNotificationSettingsDTO" : [ {
"alarmCategoriesSettings" : {
"alarmCategoriesSettings" : [ {
"categoryName" : "String value",
"includeCritical" : true,
"includeMajor" : true,
"includeMinor" : true,
"includeWarning" : true,
"isNotificationEnabled" : true,
"toAddress" : "String value"
} ]
}
} ]
}
}
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 |
Resource URL
/webacs/api/v3/op/settings/notification/alarmCategories UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alarmCategoriesSettings
|
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://localhost/webacs/api/v3/op/settings/notification/alarmCategories
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/settings/notification/alarmCategories" rootUrl="https://localhost/webacs/api/v3/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://localhost/webacs/api/v3/op/settings/notification/alarmCategories.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/settings/notification/alarmCategories",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/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"
} ]
}
} ]
}
}
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 |
Resource URL
/webacs/api/v4/op/settings/notification/alarmCategories UnmodifiedThis resource has not been modified since the previous API version.
Response Parameters
Attribute | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alarmCategoriesSettings
|
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://localhost/webacs/api/v4/op/settings/notification/alarmCategories
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/settings/notification/alarmCategories" rootUrl="https://localhost/webacs/api/v4/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://localhost/webacs/api/v4/op/settings/notification/alarmCategories.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/settings/notification/alarmCategories",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/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"
} ]
}
} ]
}
}