VueFlow
  1. AlarmLog
VueFlow
  • Vueron VueFlow Operation Manual
  • Mbembo
    • User
      • UserLogin
      • RefreshToken
    • Area
      • Stream Area Frame
    • Statistics
      • Get Zone Statistics
      • Get Zone Statistics Client
    • Event
      • Stream Event
    • AlarmLog
      • Get AlarmLog Count
        GET
      • Get AlarmLog List
        GET
  1. AlarmLog

Get AlarmLog List

GET
/api/v1/mbembo/alarmLog
Mbembo/ReportLogmbembo
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{dev_mbembo_url}}/api/v1/mbembo/alarmLog?unread=false&clientID=1&createdAt=2024-11-13T15:00:00Z&alarmType=UnderPoint&alarmType=NormalPoint'
Response Response Example
{
  "trID": "20250213091506205221",
  "resultCode": "0200",
  "resultMsg": "GetAlarmLogList OK",
  "resultData": [
    {
      "id": 223116,
      "createdAt": "2025-02-12T12:13:02.707Z",
      "clientID": 33,
      "alarmType": "UnderPoint",
      "reportMsg": "alarm.message.debiteuse",
      "reportPayload": [
        {
          "currentPoint": 0,
          "alarmPoint": 1000,
          "alarm": true,
          "lidarID": 5,
          "lidarIP": "192.168.1.85"
        },
        {
          "currentPoint": 0,
          "alarmPoint": 1000,
          "lidarID": 4,
          "lidarIP": "192.168.1.84"
        }
      ],
      "read": false,
      "client": {
        "id": 33,
        "createdAt": "2024-11-29T02:49:48.185Z",
        "updatedAt": "2025-02-12T13:18:02.34Z",
        "deletedAt": 0,
        "areaID": 4,
        "name": "newro",
        "host": "192.168.1.192",
        "port": 10221,
        "fingerprint": "5ab42ecb8ca187d26ac9d63d9b2654e8a347d14706c661098990621833351e3f",
        "frameRate": 100,
        "clientMode": 20
      }
    },
    {
      "id": 223115,
      "createdAt": "2025-02-12T12:10:46.81Z",
      "clientID": 33,
      "zoneID": 1,
      "alarmType": "ObjectViolation",
      "reportMsg": "alarm.message.bauleah",
      "reportPayload": [
        {
          "zoneID": 1,
          "vobjectID": "95923",
          "eventType": "ObjectViolation"
        }
      ],
      "read": false,
      "client": {
        "id": 33,
        "createdAt": "2024-11-29T02:49:48.185Z",
        "updatedAt": "2025-02-12T13:18:02.34Z",
        "deletedAt": 0,
        "areaID": 4,
        "name": "newro",
        "host": "192.168.1.192",
        "port": 10221,
        "fingerprint": "5ab42ecb8ca187d26ac9d63d9b2654e8a347d14706c661098990621833351e3f",
        "frameRate": 100,
        "clientMode": 20
      }
    }
  ],
  "cursor": "W3sidGFibGUiOiJhbGFybV9sb2dzIiwiY29sdW1uIjoiaWQiLCJ2YWx1ZSI6IjIyMzA5NyIsImhhdmluZyI6ZmFsc2UsInNvcnQiOiJkZXNjIn1d"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
unread
boolean 
optional
Querying alarms for readiness
Example:
false
clientID
number 
optional
query param to get a specific Client alarm
Example:
1
createdAt
string <date-time>
optional
The time value is UTC and follows ISO8601.
Example:
2024-11-13T15:00:00Z
alarmType
array[string]
optional
You can specify multiple AlarmTypes to query
Example:
["UnderPoint","NormalPoint"]
cursor
string 
optional
AlarmLog paging cursor
Example:
{{cursor}}

Responses

🟢200Success
application/json
Body
trID
string <YYYYMMDDhhmmssnnxxxx>
required
YYYYMMDDhhmmssminnnn
Example:
20250212174827129876
resultCode
enum<string> 
required
0200
Allowed values:
020014011429
resultMsg
string 
required
Request OK
errMsg
string  | null 
optional
Error Messsage if exists
cursor
string 
required
Encoded cursor information, generated by pagination only
resultData
array[object (AlarmLog) {8}] 
required
id
integer <uint64>
required
Primary key
createdAt
string <date-time>
required
Created time, ISO 8601
clientID
integer <uint64> | null 
optional
Client ID where the alarm occurred
zoneID
integer <uint64> | null 
optional
Zone ID where the alarm occurred
alarmType
enum<string> 
required
Alarm type
Allowed values:
DiskFullOsloEventRecordingStartOsloEventRecordingStopObjectViolationDirectionViolationUnderPointNormalPoint
reportMsg
string  | null 
optional
Message code for client
reportPayload
string  | integer  | boolean  | array  | object  | number  | null 
optional
Depands on AlarmType
read
boolean 
required
Read or not
Modified at 2025-02-18 04:25:27
Previous
Get AlarmLog Count
Built with