GetHistoryAlarmsForParameter
Use this method in order to retrieve the history alarms for a particular parameter.
Available from DataMiner version 9.5.1 onwards.
Input
Item | Format | Description |
---|---|---|
connection | String | The connection ID. See ConnectApp. |
dmaID | Integer | The DataMiner Agent ID. |
elementID | Integer | The element ID. |
parameterID | Integer | The parameter ID. |
tableIndex | String | The table index. This field must be specified for table column parameters; otherwise it must be left empty. |
utcStartTime | Long integer | The start time of the timespan for which alarms should be retrieved, in UTC format (milliseconds since midnight January 1, 1970 GMT). |
utcEndTime | Long integer | The end time of the timespan for which alarms should be retrieved, in UTC format (milliseconds since midnight January 1, 1970 GMT). |
filter | Array | Array of filters limiting which alarms will be retrieved. |
filter.IncludeInformationEvents | Boolean | When true, information events will also be included. |
filter.IncludeEntireAlarmTree | Boolean | When true, all alarms are included. Otherwise, only the top alarms of every alarm tree are returned. |
filter.AlarmTypes | Array of string | Only alarms with an alarm type specified in this array will be returned (default: null). |
filter.Severities | Array of string | Only alarms with a severity specified in this array will be returned (default: null). |
Output
Item | Format | Description |
---|---|---|
GetHistoryAlarmsForParameterResult | Array of DMAAlarm | The alarms for the specified parameter and period, limited by the specified filters. |