Clears all alarms with provided event type
Since Product Version: 3.3
Resource Information
|
Rate Limiting? |
No |
|
Sorting? |
No |
|
Paging? |
No |
|
Filtering? |
No |
|
Group Filtering? |
No |
|
Aggregation? |
No |
|
Response Formats |
xml json |
|
User Group |
NBI Write |
|
HTTP Methods |
PUT |
Resource URL
/webacs/api/v4/op/alarms/clearByEventType UnmodifiedThis resource has not been modified since the previous API version.
Request Parameters
| Attribute | Source | Description |
|---|---|---|
|
setSeverityToInfo Boolean |
query |
Optional True if need to set alarm severity to Info once it's cleared. False by default |
Request Payload Parameters
| Attribute | Description |
|---|---|
|
eventType String |
Required Alarm event type |
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/alarms/clearByEventType
<?xml version="1.0" ?>
<eventTypeDTO>
<eventType>String value</eventType>
</eventTypeDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/alarms/clearByEventType.json
{
"eventTypeDTO" : {
"eventType" : "String value"
}
}