Sonar

Gets the alarm table data.

get/Hardware/Sonar/Alarms/Table

Request

  • Base URL: https://api.carboncure.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.carboncure.com/Hardware/Sonar/Alarms/Table
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://auth.carboncure.com/oauth2/authorize, token URL https://auth.carboncure.com/oauth2/token, scopes: applicationId, roles)
    • none
    • none

Query parameters

technologyTypesHardwareType[]

Technology types to include.

StartTimestampstring date-time
EndTimestampstring date-time
StartDatestring date
EndDatestring date
AlarmSeverity'Low' | 'Medium' | 'High'
AlarmCodeinteger
DivisionIdinteger
PlantIdinteger
Regionstring
Countrystring
Statestring
Citystring
SystemIdstring
Limitinteger

Limit number of responses. Used for pagination.

Offsetinteger

Skip this many rows in the query. Used for pagination.

SortColumnstring

The name of the column to sort by.

SortOrder'Ascending' | 'Descending'

The order with which to sort the table by the sort column.

shouldShowSnoozedboolean

Optional parameter include snoozed alarms

shouldShowActiveboolean

Parameter to include active alarms. True by default.

Response

OK

countinteger

Changes

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