Delete an Alarm by Id
{
errorCode (integer): Error code,
errorDesc (string): Error description
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| alarmEventId | Alarm event id | path | Long |
| userId | User id | path | Long |
Delete alarm event by collectionId
{
total (integer): Total,
errorCode (integer): Error code,
errorDesc (string): Error description
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| userId | User id | path | Long |
| collectionId | Collection id | query | String |
Get Alarm events‘ details by Id
{
errorCode (integer): Error code,
errorDesc (string): Error description
id (long): Alarm id,
alarm Name (string): Alarm name,
alarmCode (string): Alarm code,
severityName (string): Name severity,
severity (short): Severity,
resoucesName (string): Device name,
resouces (long): DeviceId,
createdDate (string): Date created,
notificationMedia (short): Notice,
status (short): Status,
notificationMediaName (string): Name notice,
alarmCategoryDTO: {
id (long): Id of alarm category,
name (string): Alarm category name,
code (string): Alarm category code,
status (short): Alarm category status,
description (string): Description,
createdDate (string): Date created,
lastmodifydate (string): Last modify date
}
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| alarmEventId | Alarm event id | path | Long |
| userId | User id | path | Long |
Get Alarm Event List by Account Id
{
total (integer): Total alarm events,
errorCode (integer): Error code,
errorDesc (string): Error description,
alarmEventDTOList : [
{
id (long): Id of warning,
alarmName (string): Alarm name,
alarmCode (string): Alarm code,
severityName (string): Name severity,
severity (short): Severity weight,
resoucesName (string): Device name,
resouces (long): Id device,
createdDate (string): Date created,
notificationMedia (short): Notice,
status (short): Status,
notificationMediaName (string): Name notice,
type (byte): Type
}
]
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| userId | User id | path | Long |
| alarmCategoryId | Id of the type of alert | query | Long |
| alarmSeverity | severity | query | Integer |
| fromDate | From the date (dd-MM-yyyy) | query | String |
| searchKey | Search by name or code alert | query | String |
| start | recordings started | query | Integer |
| toDate | Go to date (dd-MM-yyyy) | query | String |
| total | Get the number of records | query | Integer |
Get Alarm event list by Device Id
{
total (integer): Total,
errorCode (integer): Error code,
errorDesc (string): Error description,
alarmEventDTOList:[
{
id (long): Id,
alarmName (string): Alarm name,
alarmCode (string): Alarm code,
severityName (string): Name severity,
severity (short): Severity,
resoucesName (string): Device name,
resouces (long): DeviceId,
createddate (string): Date created,
notificationMedia (short): notice,
status (short): Status,
notificationMediaName (string): The name announcement,
type (byte): Type
}
]
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| systemDeviceId | device id | path | Long |
| userId | User id | path | Long |
| severity | severity | query | Integer |
| start | recordings started | query | Integer |
| total | Get the number of records | query | Integer |
Get alarm event realtime by account Id
{
total (integer): Total,
errorCode (integer): Error code,
errorDesc (string): Error description,
alarmDTOList:[
{
id (long): Id of warning,
alarmName (string): Alarm name,
deviceName (string): Device name
}
]
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| userId | User id | path | Long |
| interval | Period before the current date | query | Integer |
| systemDeviceId | Device id | query | Long |
Get count alarm event by category
{
total (integer): Total,
errorCode (integer): Error code,
errorDesc (string): Error description,
alarmEventsCountList:[
{
alarmEventsCount (integer): The number of warnings,
name (string): Name warning
}
]
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| userId | User id | path | Long |
| start | Records began | query | Integer |
| total | Get the number of records | query | Integer |
Get count alarm event by device Id
{
total (integer): Total,
errorCode (integer): Error code,
errorDesc (string): Error description,
alarmEventsCountList:[
{
alarmEventsCount (integer):The number of warnings,
name (string):Name warning
}
]
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| systemDeviceId | System device id | path | Long |
| userId | User id | path | Long |
Count the event warning device
{
total (integer): Total,
errorCode (integer): Error code,
errorDesc (string): Error description,
alarmEventsDeviceCountList: [
{
deviceSystemId (long): System deviceId,
deviceName (string): The name of the device,
alarmEventsbyDeviceCount (integer): The number of warnings,
groupbyDate (string): Date created
}
]
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| systemDeviceId | Device id | path | Long |
| userId | User id | path | Long |
| alarmCategoryId | Id of the type of alert | query | Long |
| fromDate | From date (dd-MM-yyyy) | query | String |
| toDate | To date (dd-MM-yyyy) | query | String |
Get count alarm event by severity
{
total (integer): Total,
errorCode (integer): Error code,
errorDesc (string): Error description,
alarmEventsCountList:[
{
alarmEventsCount (integer):The number of warnings,
name (string):Name warning
}
]
}
| Parameter | Description | Parameter Type | Data Type |
|---|---|---|---|
| userId | User id | path | Long |
| start | Records began | query | Integer |
| total | Get the number of records | query | Integer |