Triage a device connection/recording issue

Triage a device connection/recording issue

POST /api/help/triageDevice

Triage a device connection/recording issue

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/help/triageDevice \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "startDateSec": 1642233600
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "firmwareUpdates": [
    {
      "apMac": "<string>",
      "asi": "<string>",
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "connectionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "defaultInterface": "<string>",
      "defaultInterfaceMac": "<string>",
      "deviceName": "<string>",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "firmwareVersion": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "reportingDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rssi": 123,
      "ssid": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "wifiSignalStrength": 123
    }
  ],
  "hardwareFailureEvents": [
    {
      "apMac": "<string>",
      "asi": "<string>",
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "connectionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "defaultInterface": "<string>",
      "defaultInterfaceMac": "<string>",
      "deviceName": "<string>",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "firmwareVersion": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "reportingDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "rssi": 123,
      "ssid": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "wifiSignalStrength": 123
    }
  ],
  "message": "Device appears to be functioning normally",
  "presenceWindows": [
    {
      "durationSeconds": 123,
      "startSeconds": 123
    }
  ],
  "suggestedArticles": [
    "<string>"
  ],
  "uptimeWindows": [
    {
      "durationSeconds": 123,
      "startSeconds": 123
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for triaging device connection/recording issues.

deviceUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

startDateSec · integer<int64> | null

Start date in seconds for triage analysis

Example:

1642233600

Response

200 - application/json

OK

Response object containing device triage diagnostic information.

error · boolean | null

errorMsg · string | null

firmwareUpdates · object[] | null

List of firmware update diagnostic events

Show child attributes

hardwareFailureEvents · object[] | null

List of hardware failure diagnostic events

Show child attributes

message · string | null

Triage analysis message

Example:

"Device appears to be functioning normally"

presenceWindows · object[] | null

List of device presence time windows

Show child attributes

suggestedArticles · (string | null)[] | null

List of suggested help articles for the device issue

List of suggested help articles for the device issue

uptimeWindows · object[] | null

List of device uptime time windows

Show child attributes

warningMsg · string | null