Alarm API
Jan 1 2022 at 12:00 AM
Alarm API
Alarm API is responsible for creating and maintaining a list of “live” alarms. It also provides live, historical, and statistical data relating to said alarms.
Alarms are added when an alarm entity is raised via a raise action on a trigger entity. Alarms are removed when an alarm entity is deactivated via a deactivate action on a trigger entity.
Prerequisites
To use this service you will first need to create a user in portal, create an alarm entity and link it to a relevant trigger entity.
API calls within Alarm API
Alarm
API Calls
GetList
POST
Permission
alarm:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/GetListhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/GetListURL Params
None
Data Params
{
"clientId":"string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Raise
POST
Permission
alarm:raise
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/Raisehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/RaiseURL Params
None
Data Params
{
"alarmId": "string",
"collectionKey": "string",
"customDescription": "string",
"alarmDate": DateTime,
"triggerId": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Acknowledge
Acknowledge an alarm. If it is not an active alarm it will also be removed from the alarm list.
POST
Permission
alarm:acknowledge
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/Acknowledgehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/AcknowledgeURL Params
None
Data Params
{
"clientId":"string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
BatchAcknowledge
Acknowledge numerous alarms based on filter criteria that is sent to it. If it is not an active alarm it will also be removed from the alarm list.
POST
Permission
alarm:get alarm:acknowledge
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/BatchAcknowledgehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/BatchAcknowledgeURL Params
None
Data Params
{
"clientId":"string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetAuditLog
GET
Permission
alarm.audit_log:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/GetAuditLoghttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/GetAuditLogURL Params
None
Data Params
{
"clientId":"string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetNext
GET
Permission
alarm:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/GetNexthttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/GetNextURL Params
None
Data Params
{
"filterByAlarmType": "string",
"filterBySiteEntityId": "string",
"filterByObjectEntityId": "string",
"filterVisible": "boolean",
"batchSize": "int",
"thresholdDate": "DateTime"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetGroupCount
GET
Permission
alarm:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/GetGroupCounthttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/GetGroupCountURL Params
None
Data Params
{
"filterByAlarmType": "string",
"filterBySiteEntityId": "string",
"filterByObjectEntityId": "string",
"filterByVisibility": "boolean",
"filterByPriority": ["High", "Medium", "Low"],
"groupBy": "GroupBy",
"filterByState": "State"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetGroupedListNext
GET
Permission
alarm:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/GetGroupedListNexthttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/GetGroupedListNextURL Params
None
Data Params
{
"filterByAlarmType": "string",
"filterBySiteEntityId": "string",
"filterByObjectEntityId": "string",
"filterByVisibility": "boolean",
"filterByPriority": ["High", "Medium", "Low"],
"groupBy": "GroupBy",
"activeGroupList": "string",
"pageSize": "int",
"requestedPage": "int",
"filterByState": "State"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Subscribe
SIGNAL R
Permission
alarm:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/Subscribehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/SubscribeURL Params
None
Data Params
{
"filterByAlarmType": "string",
"filterBySiteEntityId": "string",
"filterByObjectEntityId": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Unsubscribe
SIGNAL R
Permission
alarm:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/Unsubscribehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/UnsubscribeURL Params
None
Data Params
{
"filterByAlarmType": "string",
"filterBySiteEntityId": "string",
"filterByObjectEntityId": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Deactivate
POST
Permission
alarm:deactivate
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/Deactivatehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/DeactivateURL Params
None
Data Params
{
"alarmId": "string",
"collectionKey": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetAlarmStatistics
GET
Permission
alarm.statistics:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/GetAlarmStatisticshttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/GetAlarmStatisticsURL Params
None
Data Params
{
"filterObjectIdPathStartsWith": "string",
"filterVisible": "boolean"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
GetHistoricalAlarmData
GET
Permission
alarm.historical_alarm_data:get
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Alarm/GetHistoricalAlarmDatahttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Alarm/GetHistoricalAlarmDataURL Params
None
Data Params
{
"startDate": "DateTime",
"endDate": "DateTime",
"desc": "string",
"type": "string",
"priorities": ["High", "Medium", "Low"],
"rowLimit": "int",
"entityId": "string",
"aggregate": "boolean",
"offset": "TimeSpan",
"export": "boolean"
}Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Versioning
The version below may not be the same version deployed to your tenant, therefore a version mismatch can occur.
You can access your specific Open API documentation by going to:
https://{your-tenant-domain}/{your-account-path}/_apis/alarm-api/swagger/index.html
Example: https://iotnxtinternal.commander.io/default/_apis/alarm-api/swagger/index.html