Help Webservice

Triage a device connection/recording issue

Triage a device connection/recording issue

post/api/help/triageDevice

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/help/triageDevice
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

deviceUuidstring RUUID nullable

base 64 (url-safe) uuid string

startDateSecinteger nullable

Start date in seconds for triage analysis

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "startDateSec": 1642233600
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
messagestring nullable

Triage analysis message

suggestedArticlesstring[] nullable

List of suggested help articles for the device issue

warningMsgstring nullable

Example response

{
  "firmwareUpdates": [
    {
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "connectionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "reportingDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "hardwareFailureEvents": [
    {
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "connectionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "reportingDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "message": "Device appears to be functioning normally"
}

Changes

No recorded changes to this operation across all 1 revision of this API.