system.diagnostics.heartbeat (Heartbeat)
system.diagnostics.heartbeat: Heartbeat
system.diagnostics.heartbeat · device scope · message query permission Alarm
What it does
Reported on heartbeat. msgType is system.diagnostics.heartbeat (legacy everyMinEvent/19002 merged into this page). Subscribe to capabilityEvent; search via the event catalog and history/search APIs. See Event catalog, Overview and common payload, and Receive device messages and setMessageCallback.
Reported fields
outputData may be {} or contain only the optional index. Platform fields: Overview and common payload.
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
index | Index. Range 0–10000, step 1. | int | no | 0–10000, step 1 |
Example
{
"msgType": "system.diagnostics.heartbeat",
"deviceId": "TESTIPC000012345",
"productId": "56WGTET2",
"outputData": {
"index": 0
},
"time": 1673406989,
"localTime": "20230111T111629",
"alarmId": "116257862023505xxxx"
}
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the alarm message permission. A bound sub-user does not. When a sub-account queries messages for this event, each message is checked against the capability row share/sub codes (system.diagnostics is usually Config). list / search filters out events without permission. Diagnostics.