v51

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB

Alarms

List Alarms

Retrieve a list of alarms.

get/v1/alarms

rootObjectinteger

ID of root object for alarm retrieval (0 to retrieve all alarms)

includeObjectDetailsboolean

If true, include full source object details in response

Successful retrieval of alarms.

idinteger

severityinteger

Current severity: 0=Normal, 1=Warning, 2=Minor, 3=Major, 4=Critical

stateinteger

Alarm state: 0=Outstanding, 1=Acknowledged, 2=Resolved, 3=Terminated

sourceinteger

Source object ID

sourceNamestring

Name of the source object

zoneUINinteger

Zone UIN of the source object (0 if zoning is disabled)

messagestring

repeatCountinteger

Number of times the alarm was raised

commentCountinteger

Number of comments attached to the alarm

helpdeskReferencestring

Helpdesk issue reference (empty if not linked)

creationTimestring date-time

lastChangeTimestring date-time

ackByUserNamestring

Name of the user who acknowledged the alarm (empty if not acknowledged)

resolvedByUserNamestring

Name of the user who resolved the alarm (empty if not resolved)