Retrieves configuration for automatic deletion periods of alarms
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
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/alarmDeletionPeriods
Response Parameters
activeAndCleared
Integer
|
Active and cleared alarms automatic deletion period (in days)
|
allEvents
Integer
|
All events automatic deletion period (in days)
|
clearedNonSecurityAlarms
Integer
|
Cleared non-security alarms automatic deletion period (in days)
|
clearedSecurityAlarms
Integer
|
Cleared security alarms automatic deletion period (in days)
|
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.56.58.149/webacs/api/v1/op/settings/alarms/alarmDeletionPeriods
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v1/op/settings/alarms/alarmDeletionPeriods" rootUrl="https://10.56.58.149/webacs/api/v1/op">
<alarmDeletionPeriodsDto>
<activeAndCleared>15</activeAndCleared>
<allEvents>15</allEvents>
<clearedNonSecurityAlarms>15</clearedNonSecurityAlarms>
<clearedSecurityAlarms>15</clearedSecurityAlarms>
</alarmDeletionPeriodsDto>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v1/op/settings/alarms/alarmDeletionPeriods.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op\/settings\/alarms\/alarmDeletionPeriods",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/op",
"alarmDeletionPeriodsDto" : {
"activeAndCleared" : 15,
"allEvents" : 15,
"clearedNonSecurityAlarms" : 15,
"clearedSecurityAlarms" : 15
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/settings/alarms/alarmDeletionPeriods
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
activeAndCleared
Integer
|
Active and cleared alarms automatic deletion period (in days)
|
allEvents
Integer
|
All events automatic deletion period (in days)
|
clearedNonSecurityAlarms
Integer
|
Cleared non-security alarms automatic deletion period (in days)
|
clearedSecurityAlarms
Integer
|
Cleared security alarms automatic deletion period (in days)
|
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.56.58.149/webacs/api/v2/op/settings/alarms/alarmDeletionPeriods
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v2/op/settings/alarms/alarmDeletionPeriods" rootUrl="https://10.56.58.149/webacs/api/v2/op">
<alarmDeletionPeriodsDto>
<activeAndCleared>15</activeAndCleared>
<allEvents>15</allEvents>
<clearedNonSecurityAlarms>15</clearedNonSecurityAlarms>
<clearedSecurityAlarms>15</clearedSecurityAlarms>
</alarmDeletionPeriodsDto>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v2/op/settings/alarms/alarmDeletionPeriods.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v2/op/settings/alarms/alarmDeletionPeriods",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v2/op",
"alarmDeletionPeriodsDto" : [ {
"activeAndCleared" : 15,
"allEvents" : 15,
"clearedNonSecurityAlarms" : 15,
"clearedSecurityAlarms" : 15
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/settings/alarms/alarmDeletionPeriods
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
activeAndCleared
Integer
|
Active and cleared alarms automatic deletion period (in days)
|
allEvents
Integer
|
All events automatic deletion period (in days)
|
clearedNonSecurityAlarms
Integer
|
Cleared non-security alarms automatic deletion period (in days)
|
clearedSecurityAlarms
Integer
|
Cleared security alarms automatic deletion period (in days)
|
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.56.58.149/webacs/api/v3/op/settings/alarms/alarmDeletionPeriods
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v3/op/settings/alarms/alarmDeletionPeriods" rootUrl="https://10.56.58.149/webacs/api/v3/op">
<alarmDeletionPeriodsDto>
<activeAndCleared>15</activeAndCleared>
<allEvents>15</allEvents>
<clearedNonSecurityAlarms>15</clearedNonSecurityAlarms>
<clearedSecurityAlarms>15</clearedSecurityAlarms>
</alarmDeletionPeriodsDto>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v3/op/settings/alarms/alarmDeletionPeriods.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v3/op/settings/alarms/alarmDeletionPeriods",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v3/op",
"alarmDeletionPeriodsDto" : [ {
"activeAndCleared" : 15,
"allEvents" : 15,
"clearedNonSecurityAlarms" : 15,
"clearedSecurityAlarms" : 15
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/settings/alarms/alarmDeletionPeriods
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
activeAndCleared
Integer
|
Active and cleared alarms automatic deletion period (in days)
|
allEvents
Integer
|
All events automatic deletion period (in days)
|
clearedNonSecurityAlarms
Integer
|
Cleared non-security alarms automatic deletion period (in days)
|
clearedSecurityAlarms
Integer
|
Cleared security alarms automatic deletion period (in days)
|
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.56.58.149/webacs/api/v4/op/settings/alarms/alarmDeletionPeriods
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v4/op/settings/alarms/alarmDeletionPeriods" rootUrl="https://10.56.58.149/webacs/api/v4/op">
<alarmDeletionPeriodsDto>
<activeAndCleared>15</activeAndCleared>
<allEvents>15</allEvents>
<clearedNonSecurityAlarms>15</clearedNonSecurityAlarms>
<clearedSecurityAlarms>15</clearedSecurityAlarms>
</alarmDeletionPeriodsDto>
</mgmtResponse>
Sample JSON Response Payload
https://10.56.58.149/webacs/api/v4/op/settings/alarms/alarmDeletionPeriods.json
{
"mgmtResponse" : {
"@requestUrl" : "https://10.56.58.149/webacs/api/v4/op/settings/alarms/alarmDeletionPeriods",
"@responseType" : "operation",
"@rootUrl" : "https://10.56.58.149/webacs/api/v4/op",
"alarmDeletionPeriodsDto" : [ {
"activeAndCleared" : 15,
"allEvents" : 15,
"clearedNonSecurityAlarms" : 15,
"clearedSecurityAlarms" : 15
} ]
}
}