Retrieves current alarms notification settings
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
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
alarmCategoriesSettings
AlarmCategoryNotificationSettingsDTO[]
|
Array of notification settings per alarm category (at least one category is required)
|
categoryName
String
|
Name of alarm category that notification settings belongs to (required)
|
includeCritical
Boolean
|
Indicates if we should send notifications for Critical alarms (optional, default value will be "false")
|
includeMajor
Boolean
|
Indicates if we should send notifications for Major alarms (optional, default value will be "false")
|
includeMinor
Boolean
|
Indicates if we should send notifications for Minor alarms (optional, default value will be "false")
|
includeWarning
Boolean
|
Indicates if we should send notifications for Warning alarms (optional, default value will be "false")
|
isNotificationEnabled
Boolean
|
Indicates if we should send notifications for this alarm category (optional, default value will be "false")
|
toAddress
String
|
Comma separated list of mail notification recipients (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/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?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/settings/notification/alarmCategories
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
alarmCategoriesSettings
AlarmCategoryNotificationSettingsDTO[]
|
Array of notification settings per alarm category (at least one category is required)
|
categoryName
String
|
Name of alarm category that notification settings belongs to (required)
|
includeCritical
Boolean
|
Indicates if we should send notifications for Critical alarms (optional, default value will be "false")
|
includeMajor
Boolean
|
Indicates if we should send notifications for Major alarms (optional, default value will be "false")
|
includeMinor
Boolean
|
Indicates if we should send notifications for Minor alarms (optional, default value will be "false")
|
includeWarning
Boolean
|
Indicates if we should send notifications for Warning alarms (optional, default value will be "false")
|
isNotificationEnabled
Boolean
|
Indicates if we should send notifications for this alarm category (optional, default value will be "false")
|
toAddress
String
|
Comma separated list of mail notification recipients (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?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/settings/notification/alarmCategories
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
alarmCategoriesSettings
AlarmCategoryNotificationSettingsDTO[]
|
Array of notification settings per alarm category (at least one category is required)
|
categoryName
String
|
Name of alarm category that notification settings belongs to (required)
|
includeCritical
Boolean
|
Indicates if we should send notifications for Critical alarms (optional, default value will be "false")
|
includeMajor
Boolean
|
Indicates if we should send notifications for Major alarms (optional, default value will be "false")
|
includeMinor
Boolean
|
Indicates if we should send notifications for Minor alarms (optional, default value will be "false")
|
includeWarning
Boolean
|
Indicates if we should send notifications for Warning alarms (optional, default value will be "false")
|
isNotificationEnabled
Boolean
|
Indicates if we should send notifications for this alarm category (optional, default value will be "false")
|
toAddress
String
|
Comma separated list of mail notification recipients (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?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/op/settings/notification/alarmCategories
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
alarmCategoriesSettings
AlarmCategoryNotificationSettingsDTO[]
|
Array of notification settings per alarm category (at least one category is required)
|
categoryName
String
|
Name of alarm category that notification settings belongs to (required)
|
includeCritical
Boolean
|
Indicates if we should send notifications for Critical alarms (optional, default value will be "false")
|
includeMajor
Boolean
|
Indicates if we should send notifications for Major alarms (optional, default value will be "false")
|
includeMinor
Boolean
|
Indicates if we should send notifications for Minor alarms (optional, default value will be "false")
|
includeWarning
Boolean
|
Indicates if we should send notifications for Warning alarms (optional, default value will be "false")
|
isNotificationEnabled
Boolean
|
Indicates if we should send notifications for this alarm category (optional, default value will be "false")
|
toAddress
String
|
Comma separated list of mail notification recipients (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"
} ]
}
} ]
}
}