Alarms

List Alarms

Retrieve a list of alarms.

get/v1/alarms

Query parameters

rootObjectinteger

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

includeObjectDetailsboolean

If true, include full source object details in response

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)

Changes

Changed in 13 of the 115 revisions of this API.3615

    • ●

      added the new Room enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new CoolingZone enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Facility enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new PowerDomain enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ▲

      the /////// response's property type changed from integer to string for status

      response-property-type-changed

    • ▲

      the /////// response's property type changed from string to integer for status

      response-property-type-changed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ▲

      the /////// response's property type changed from integer to string for status

      response-property-type-changed

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added