Robot

Find waypoint runs by route

Find waypoint runs for a route, filtered by time range.

POST/api/robot/findWaypointRunsByRoute

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 waypoint runs for a given route within a time range.

endMsinteger<int64> | nullbody

End of the time range in epoch milliseconds, defaults to Long.MAX_VALUE

routeUuidstring<RUUID> | nullbodyrequired

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startMsinteger<int64> | nullbodyrequired

Start of the time range in epoch milliseconds

bash

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

import requests

url = "https://api2.rhombussystems.com/api/robot/findWaypointRunsByRoute"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "endMs": 0,
    "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "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/findWaypointRunsByRoute', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "endMs": 0,
    "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "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 = """
            {
              "endMs": 0,
              "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "startMs": 0
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/robot/findWaypointRunsByRoute"))
            .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

{
  "error": false,
  "waypointRuns": [
    {
      "actionStatusMap": {
        "<key>": {
          "status": "COMPLETED",
          "updatedAtMs": 0
        }
      },
      "arrivedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "arrivedAtMs": 0,
      "completedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "completedAtMs": 0,
      "createdAtMs": 0,
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "dwellStrategy": "DURATION",
      "dwellTimeMs": 0,
      "name": "<string>",
      "ordinal": 0,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "parentRouteRunUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "parentRouteUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "poseAchieved": {
        "orientation": [
          0
        ],
        "position": [
          0
        ]
      },
      "poseTarget": {
        "orientation": [
          0
        ],
        "position": [
          0
        ]
      },
      "routeWaypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ruleReferences": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "startedAtEventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "startedAtMs": 0,
      "status": "PENDING",
      "updatedAtMs": 0,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Response

200 OK

application/json · object

Response containing the waypoint runs for a route.

errorboolean | null

errorMsgstring | null

warningMsgstring | null

waypointRunsobject[] | null

List of waypoint runs for the route

Show child attributes

actionStatusMapobject | null

Show child attributes

statusenum<string>

Available options: NOT_STARTED, COMPLETED, ABORTED, UNKNOWN

updatedAtMsinteger<int64> | null

arrivedAtEventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

arrivedAtMsinteger<int64> | null

completedAtEventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

completedAtMsinteger<int64> | null

createdAtMsinteger<int64> | null

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

dwellStrategyenum<string>default: DURATION

Strategy for how long the robot dwells at this waypoint

Available options: NONE, DURATION, TIME_ABSOLUTE, EVENT, MANUAL, UNKNOWN

dwellTimeMsinteger<int64> | null

namestring | null

ordinalinteger<int32> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

parentRouteRunUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

parentRouteUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

poseAchievedobject

Show child attributes

orientationnumber<double>[] | null

Items: 4 to 4

positionnumber<double>[] | null

Items: 3 to 3

poseTargetobject

Show child attributes

orientationnumber<double>[] | null

Items: 4 to 4

positionnumber<double>[] | null

Items: 3 to 3

routeWaypointUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ruleReferencesstring<RUUID>[] | null

startedAtEventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startedAtMsinteger<int64> | null

statusenum<string>

Available options: PENDING, NAVIGATING, ARRIVED, COMPLETED

updatedAtMsinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

waypointUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"