Alarms

List alarms changed since a sequence number

Returns alarms whose SequenceNumber is higher than the one sent. An alarm gets a new sequence number when it changes, including when it is closed. Send one, and only one, of clientID, facilityID, deviceID or endpointID, and keep the same filter between calls.

get/api/v2/alarms/incremental/{sequenceNumber}

Request

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

Path parameters

sequenceNumberinteger required

SequenceNumber of the last item received. Use 0 to start from the beginning.

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.

maxCountinteger

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

Response

Alarms changed since sequenceNumber. An empty list means there is nothing new.

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.