Alarm Audit Service
Jan 1 2022 at 12:00 AM
Alarm Audit Service
The Alarm Audit Service is responsible for logging actions on alarms made by users, for example: A user acknowledging an alarm.
API calls within Alarm Audit Service
Alarm Audit Service
API Calls
GetAlarmAuditLogByFilter
GET
Permission
None
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/AlarmAudit/GetAlarmAuditLogByFilterhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/AlarmAudit/GetAlarmAuditLogByFilterURL Params
None
Data Params
"filters":
{
"PropertyName": "string",
"Value": {object},
"Operand": "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
LogAlarmReceivedAudit
POST
Permission
None
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/AlarmAudit/LogAlarmReceivedAudithttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/AlarmAudit/LogAlarmReceivedAuditURL Params
None
Data Params
"alarmReceivedAudit":
{
{
"AlarmAuditId": "string",
"CommanderReceivedDateTime": "DateTime",
"Alarm":
{
"AlarmInstanceId": "string",
"IdPath": "string"
}, "AlarmReceivedAuditDateTime": "DateTime",
"ReceivedByUser": "string"
},
{
"AlarmAuditId": "string",
"CommanderReceivedDateTime": "DateTime",
"Alarm":
{
"AlarmInstanceId": "string",
"IdPath": "string"
},
"AlarmReceivedAuditDateTime": "DateTime",
"ReceivedByUser": "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
GetDynamicConfig
POST
Permission
ALARMAUDIT_DYNAMICCONFIG_GET
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/AlarmAudit/GetDynamicConfighttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/AlarmAudit/GetDynamicConfigURL Params
None
Data Params
None
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
SetDynamicConfig
POST
Permission
ALARMAUDIT_DYNAMICCONFIG_SET
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/AlarmAudit/SetDynamicConfighttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/AlarmAudit/SetDynamicConfigURL Params
None
Data Params
"config":
{
"AuditAlarmReceives": "bool"
}
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
GetVersion
GET
Permission
None
Accessible
Tenant Account Only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/AlarmAudit/GetVersionhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/AlarmAudit/GetVersionURL Params
None
Data Params
None
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