API Reference

Get alarm details using filter criteria

get
https://example.com/lr-alarm-api/alarms

Search and get alarm details by using different filter criteria

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Query Params
integer

The number of items to skip before starting to collect the result set

integer

The numbers of items to return

string

provide field name (AlarmRuleName, AlarmStatus, DateInserted and entityName) on which user can sort the result

string

provide order direction either ascending or descending

string

provide alarm rule name to get the result

string
enum

Can provide enum value in string or number format [New = 0, Opened = 1, Working = 2, Escalated = 3, Closed = 4, Closed_FalseAlarm = 5, Closed_Resolved = 6, Closed_Unresolved = 7, Closed_Reported = 8, Closed_Monitor = 9]

string

Filter result by entity name

boolean

Filter result by notification, whether you are (true) or are not (false) in the notification list. Blank value returns all alarms regardless of who was notified.

string

Filter result by case associated to the alarm

string

Filter result by date inserted

Responses

403

A User without correct permission tried to fetch the alarm history details.

404

alarm not found in database.

Updated 7 months ago

Language
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago