Retrieves existing configuration for alarms. Returns tree of alarm types groups containing all alarms with their severities and auto clear ages if configured.
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Credential
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v1/op/settings/alarms/severityAutoClearConfig
Response Parameters
groups
SeverityAutoClearConfigTree[]
|
|
groups
SeverityAutoClearConfigTree[]
|
|
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarms types.
|
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
|
|
name
String
|
|
|
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarms types.
|
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
|
|
name
String
|
|
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/alarms/severityAutoClearConfig
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/settings/alarms/severityAutoClearConfig" rootUrl="https://localhost/webacs/api/v1/op">
<severityAutoClearConfigTree>
<groups>
<groups>
<groups>
<groups>
<groups>
<groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</severityAutoClearConfigTree>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/settings/alarms/severityAutoClearConfig.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/settings\/alarms\/severityAutoClearConfig",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"severityAutoClearConfigTree" : {
"groups" : {
"groups" : {
"groups" : {
"groups" : {
"groups" : {
"groups" : {
"items" : {
"items" : {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}
},
"name" : "String value"
}
},
"items" : {
"items" : {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}
},
"name" : "String value"
}
},
"items" : {
"items" : {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}
},
"name" : "String value"
}
},
"items" : {
"items" : {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}
},
"name" : "String value"
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
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.
Response Parameters
groups
SeverityAutoClearConfigTree[]
|
|
groups
SeverityAutoClearConfigTree[]
|
|
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarms types.
|
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
|
|
name
String
|
|
|
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarms types.
|
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
|
|
name
String
|
|
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/alarms/severityAutoClearConfig
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/settings/alarms/severityAutoClearConfig" rootUrl="https://localhost/webacs/api/v2/op">
<severityAutoClearConfigTree>
<groups>
<groups>
<groups>
<groups>
<groups>
<groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</severityAutoClearConfigTree>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/settings/alarms/severityAutoClearConfig.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/settings/alarms/severityAutoClearConfig",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"severityAutoClearConfigTree" : [ {
"groups" : {
"groups" : [ {
"groups" : {
"groups" : [ {
"groups" : {
"groups" : [ {
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
},
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
},
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
},
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
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.
Response Parameters
groups
SeverityAutoClearConfigTree[]
|
|
groups
SeverityAutoClearConfigTree[]
|
|
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarms types.
|
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
|
|
name
String
|
|
|
items
PartialSeverityAutoClearConfigDto[]
|
Configurations for alarms types.
|
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
|
|
name
String
|
|
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/alarms/severityAutoClearConfig
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/settings/alarms/severityAutoClearConfig" rootUrl="https://localhost/webacs/api/v3/op">
<severityAutoClearConfigTree>
<groups>
<groups>
<groups>
<groups>
<groups>
<groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
<groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
<groups>
<groups>
<groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</groups>
</groups>
<items>
<items>
<alarmCondition>String value</alarmCondition>
<alarmType>String value</alarmType>
<autoClearAge>15</autoClearAge>
<isAutoClearSupported>true</isAutoClearSupported>
<severity>INFORMATION</severity>
</items>
</items>
<name>String value</name>
</severityAutoClearConfigTree>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/settings/alarms/severityAutoClearConfig.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/settings/alarms/severityAutoClearConfig",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"severityAutoClearConfigTree" : [ {
"groups" : {
"groups" : [ {
"groups" : {
"groups" : [ {
"groups" : {
"groups" : [ {
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}, {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
},
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}, {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
}, {
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}, {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
},
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
}, {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
}, {
"groups" : {
"groups" : [ {
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
},
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
},
"items" : {
"items" : [ {
"alarmCondition" : "String value",
"alarmType" : "String value",
"autoClearAge" : 15,
"isAutoClearSupported" : true,
"severity" : "INFORMATION"
} ]
},
"name" : "String value"
} ]
}
}