Skip to main content
Contact Us

OpenManage Enterprise 3.10 RESTful API Guide

PDF

/api/AlertService/Alerts

This URI represents the alerts.

Table 1. FiltersThis table lists the filters that this URI supports.
Filter name Description
Top Top records to return. Default value is 100. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$skip=100&$top=100
Skip Max records to skip. Default value is 0. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$skip=100&$top=100
Orderby Order to apply to the output. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$orderby=AlertDeviceIpAddress
Id Filter by event ID. Default value is 0. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=Id eq 812
AlertDeviceId Filter by device ID. Default value is 0. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=AlertDeviceId eq 0
AlertDeviceIdentifier Filter by device identifier. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=contains(AlertDeviceIdentifier, '')
AlertDeviceType Filter by device type. Default value is 0. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=AlertDeviceIdentifier eq 1
SeverityType Filter by severity type. Default value is 0. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=SeverityType eq 2
StatusType Filter by status type. Default value is 0. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=StatusType eq 2000
CategoryId Filter by category ID. Default value is 0. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=CategoryId eq 5
SubCategoryId Filter by subcategory ID. Default value is 0. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=CategoryId eq 27
SubCategoryName Filter by subcategory name. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=contains(SubCategoryName,'Job')
Message Filter by message. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=contains(Message,'successfully completed')
TimeStampBegin Filter by starting time of alerts. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=TimeStamp ge '2023-11-29 16:00:30.525' and TimeStamp le '2023-11-29 18:00:30.525'
TimeStampEnd Filter by ending time of alert. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=TimeStamp ge '2023-11-29 16:00:30.525' and TimeStamp le '2023-11-29 18:00:30.525'
AlertDeviceName Filter by alert device name. 
https://xx.xx.xx.xx/api/AlertService/Alerts?$filter=contains(AlertDeviceName, '')

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\