White Papers

42 REST API Guide  OpenManage Essentials | Revision A02
Attribute Name
Description
Id
The unique identifier for the filter.
Name
The name of the filter.
Type
The type of filter (for example, view filter, action filter, and so on).
IsEnabled
A flag indicating whether the filter is enabled or disabled.
IsReadOnly
A flag indicating whether the filter is read-only or editable.
To retrieve alerts associated with a specific alert filter, the following resource URI can be used:
The following URI enables filtering the alerts based on the criteria defined by the alert filter.
<BASE_URI>/AlertFilters/<ID>/Alerts
To get a summary by severity for each alert filter, the following URI can be used:
<BASE_URI>/AlertFilters/<ID>/Summary
The attributes associated with the alert filter are described in the following table.
Attribute Name
Description
TotalAlerts
The total number of alerts that match the filter criteria.
CriticalCount
The number if alerts with a critical severity.
WarningCount
The number of alerts with a warning severity.
NormalCount
The number of alerts with a normal severity.
InfoCount
The number of alerts with an informational severity.
UnknownCount
The number of alerts with an unknown severity.
2.8 Alerts
The resource URIs in this section can be used to return information on alert operations. Alerts can either be
scoped based on the device or can be accessed globally.
Alerts (per filter) : <BASE_URI>/AlertFilters/<ID>/Alerts
Alerts (per device) : <DEVICE_BASE_URI>/<ID>/Alerts (where <ID> is the device identifier)
All alerts: <BASE_URI>/Alerts
Alerts (sorted): <BASE_URI>/Alerts/$sort(column=<attribute name(s)>;direction=<sort direction(s)>)