Updates alarm settings for passed types changing severities and auto clear ages.
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/alarms/severityAutoClearConfig
Request Payload Parameters
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarm types. Specify desired severity, or pass "DEFAULT" as the severity to reset the setting to default value.
|
alarmCondition
String
|
Condition triggering alarms of this type
|
alarmType
String
|
|
autoClearAge
Integer
|
Time in hours before alarms triggered by the condition are cleared automatically
|
isAutoClearSupported
boolean
|
Indicates if auto clear option is supported for this alarm type
|
severity
AlarmSeverityLevelEnum
|
Severity level set for alarms triggered by the condition
Allowed values:
INFORMATION
WARNING
MINOR
MAJOR
CRITICAL
DEFAULT
|
|
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 Request Payload
https://localhost/webacs/api/v1/op/settings/alarms/severityAutoClearConfig
<?xml version="1.0" ?>
<alarmSeverityAutoClearConfigCommandDto>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
</alarmSeverityAutoClearConfigCommandDto>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/settings/alarms/severityAutoClearConfig.json
{
"alarmSeverityAutoClearConfigCommandDto" : {
"items" : {
"items" : {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}
}
}
}
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/alarms/severityAutoClearConfig
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarm types. Specify desired severity, or pass "DEFAULT" as the severity to reset the setting to default value.
|
alarmCondition
String
|
Condition triggering alarms of this type
|
alarmType
String
|
|
autoClearAge
Integer
|
Time in hours before alarms triggered by the condition are cleared automatically
|
isAutoClearSupported
boolean
|
Indicates if auto clear option is supported for this alarm type
|
severity
AlarmSeverityLevelEnum
|
Severity level set for alarms triggered by the condition
Allowed values:
INFORMATION
WARNING
MINOR
MAJOR
CRITICAL
DEFAULT
|
|
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 Request Payload
https://localhost/webacs/api/v2/op/settings/alarms/severityAutoClearConfig
<?xml version="1.0" ?>
<alarmSeverityAutoClearConfigCommandDto>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
</alarmSeverityAutoClearConfigCommandDto>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/settings/alarms/severityAutoClearConfig.json
{
"alarmSeverityAutoClearConfigCommandDto" : {
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
}
}
}
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/alarms/severityAutoClearConfig
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarm types. Specify desired severity, or pass "DEFAULT" as the severity to reset the setting to default value.
|
alarmCondition
String
|
Condition triggering alarms of this type
|
alarmType
String
|
|
autoClearAge
Integer
|
Time in hours before alarms triggered by the condition are cleared automatically
|
isAutoClearSupported
boolean
|
Indicates if auto clear option is supported for this alarm type
|
severity
AlarmSeverityLevelEnum
|
Severity level set for alarms triggered by the condition
Allowed values:
INFORMATION
WARNING
MINOR
MAJOR
CRITICAL
DEFAULT
|
|
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 Request Payload
https://localhost/webacs/api/v3/op/settings/alarms/severityAutoClearConfig
<?xml version="1.0" ?>
<alarmSeverityAutoClearConfigCommandDto>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
<items>
<alarmCondition>Another string value</alarmCondition>
<alarmType>Another string value</alarmType>
<autoClearAge>25</autoClearAge>
<isAutoClearSupported>false</isAutoClearSupported>
<severity>WARNING</severity>
</items>
</items>
</alarmSeverityAutoClearConfigCommandDto>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/settings/alarms/severityAutoClearConfig.json
{
"alarmSeverityAutoClearConfigCommandDto" : {
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}, {
"alarmCondition" : "Another string value",
"alarmType" : "Another string value",
"autoClearAge" : 25,
"isAutoClearSupported" : false,
"severity" : "WARNING"
} ]
}
}
}
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/alarms/severityAutoClearConfig
Unmodified
This resource has not been modified since the previous API version.
Request Payload Parameters
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarm types. Specify desired severity, or pass "DEFAULT" as the severity to reset the setting to default value.
|
alarmCondition
String
|
Condition triggering alarms of this type
|
alarmType
String
|
|
autoClearAge
Integer
|
Time in hours before alarms triggered by the condition are cleared automatically
|
isAutoClearSupported
boolean
|
Indicates if auto clear option is supported for this alarm type
|
severity
AlarmSeverityLevelEnum
|
Severity level set for alarms triggered by the condition
Allowed values:
INFORMATION
WARNING
MINOR
MAJOR
CRITICAL
DEFAULT
|
|
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 Request Payload
https://localhost/webacs/api/v4/op/settings/alarms/severityAutoClearConfig
<?xml version="1.0" ?>
<alarmSeverityAutoClearConfigCommandDto>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
<items>
<alarmCondition>Another string value</alarmCondition>
<alarmType>Another string value</alarmType>
<autoClearAge>25</autoClearAge>
<isAutoClearSupported>false</isAutoClearSupported>
<severity>WARNING</severity>
</items>
</items>
</alarmSeverityAutoClearConfigCommandDto>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/settings/alarms/severityAutoClearConfig.json
{
"alarmSeverityAutoClearConfigCommandDto" : {
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}, {
"alarmCondition" : "Another string value",
"alarmType" : "Another string value",
"autoClearAge" : 25,
"isAutoClearSupported" : false,
"severity" : "WARNING"
} ]
}
}
}