Alarms

List alarms

Send one, and only one, of clientID, facilityID, deviceID or endpointID.

get/api/v2/alarms

Request

  • Base URL: https://gear.cloud.studio
  • URL: https://gear.cloud.studio/api/v2/alarms
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter accessToken

Query parameters

clientIDinteger

Only items of this client.

facilityIDinteger

Only items of this facility.

deviceIDinteger

Only items of this device.

endpointIDinteger

Only items of this endpoint.

dateFromstring

Date from which items are returned.

dateTostring

Date until which items are returned.

state'open' | 'closed' | 'all'

Alarm state to return.

maxCountinteger

Maximum number of records in the result. Values above 500 are limited to 500.

Response

Matching alarms.

AlarmIDinteger
DeviceIDinteger
EndpointIDinteger
AlarmTypeIDinteger
AlarmTypeDescriptionstring
AlarmSeverityID0 | 1 | 2 | 3

0 information, 1 low, 2 medium, 3 high.

AlarmSeverityDescriptionstring
Detailsstring
DateTimeCreated_UTCstring
DateTimeClosed_UTCstring
SequenceNumberinteger

Changes

No recorded changes to this operation across all 1 revision of this API.