Robot

Find robot events

Stream behavior/activity events emitted by a robot within a time range as newline-delimited JSON (one RobotEvent JSON object per line).

POST/api/robot/findRobotEvents

Authorizations

x-auth-apikeystringheaderrequired

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-schemeenum<string>headerrequireddefault: api-token

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 · object

Request to find robot events for a given robot within a time range.

deviceUuidstring<RUUID> | nullbodyrequired

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

endMsinteger<int64> | nullbody

End of the time range in epoch milliseconds (exclusive)

startMsinteger<int64> | nullbodyrequired

Start of the time range in epoch milliseconds (inclusive)

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/robot/findRobotEvents' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "endMs": 0,
    "startMs": 0
  }'

import requests

url = "https://api2.rhombussystems.com/api/robot/findRobotEvents"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "endMs": 0,
    "startMs": 0
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/robot/findRobotEvents', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "endMs": 0,
    "startMs": 0
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "endMs": 0,
              "startMs": 0
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/robot/findRobotEvents"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "activity": "IDLE",
  "activityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "createdAtMs": 0,
  "description": "<string>",
  "distanceRemaining": 0,
  "estimatedTimeRemainingSec": 0,
  "event": "STARTED",
  "failureReason": "<string>",
  "goalPose": {
    "orientation": [
      0
    ],
    "position": [
      0
    ]
  },
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "navigationTimeSec": 0,
  "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "originator": {
    "auditPrincipal": "<string>",
    "type": "USER",
    "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "grantedToName": "<string>",
    "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "supportUserEmail": "<string>",
    "supportUsername": "<string>"
  },
  "phase": "<string>",
  "phaseEvent": "<string>",
  "phaseUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "preemptedBy": {
    "activity": "IDLE",
    "priority": 0
  },
  "priority": 0,
  "robotUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "startedAtMs": 0,
  "timestampMs": 0,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "waypointIndex": 0,
  "waypointTotal": 0,
  "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

200 OK

application/x-ndjson · object | null

activityenum<string>

Available options: IDLE, MANUAL_CMD_VEL, MANUAL_ACTION, MANUAL_POSTURE, NAVIGATE_TO_POSE, NAVIGATE_TO_HOME, NAVIGATE_TO_WAYPOINT, ROUTE_RUN, LOW_BATTERY_DOCKING, IDLE_DOCKING, DWELLING, EMERGENCY, EXPLORE_AND_MAP, EXPLORE_AREA, MAINTENANCE_HOLD, UNKNOWN

activityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMsinteger<int64> | null

descriptionstring | null

distanceRemainingnumber<float> | null

estimatedTimeRemainingSecnumber<double> | null

eventenum<string>

Available options: STARTED, PROGRESS, SUSPENDED, RESUMED, COMPLETED, FAILED, CANCELED, REJECTED, UNKNOWN

failureReasonstring | null

goalPoseobject

Show child attributes

orientationnumber<double>[] | null

Items: 4 to 4

positionnumber<double>[] | null

Items: 3 to 3

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

navigationTimeSecnumber<double> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobject

Show child attributes

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | null

supportAuthorityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | null

supportUsernamestring | null

Show Api Token variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | null

tokenUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | null

Show Rule variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | null

ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | null

componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | null

eventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobject

Show Guest Pass variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | null

guestPassUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | null

phasestring | null

phaseEventstring | null

phaseUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

preemptedByobject

Show child attributes

activityenum<string>

priorityinteger<int32> | null

robotUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

routeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startedAtMsinteger<int64> | null

timestampMsinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

waypointIndexinteger<int32> | null

waypointTotalinteger<int32> | null

waypointUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"