Robot

Retrieve the list of available robot maps

POST/api/robot/findMaps

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

Find robot maps

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

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

import requests

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

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/findMaps', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }),
});
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 = """
            {
              "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/robot/findMaps"))
            .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,
  "maps": [
    {
      "enabled": true,
      "etag": "<string>",
      "floorPlan": {
        "eastEdge": 0,
        "floorNumber": 0,
        "northEdge": 0,
        "rotation": 0,
        "southEdge": 0,
        "westEdge": 0
      },
      "freeThresh": 0,
      "initiatedByDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "negate": 0,
      "occupiedThresh": 0,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "origin": [
        0
      ],
      "resolution": 0,
      "sizeBytes": 0,
      "uploadState": "PENDING",
      "uploaded": true,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Response

200 OK

application/json · object

A list of available robot maps.

errorboolean | null

errorMsgstring | null

mapsobject[] | null

Show child attributes

enabledboolean | null

etagstring | null

floorPlanobject

Show child attributes

eastEdgenumber<double> | null

floorNumberinteger<int32> | null

northEdgenumber<double> | null

rotationnumber<double> | null

southEdgenumber<double> | null

westEdgenumber<double> | null

freeThreshnumber<double> | null

initiatedByDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

negateinteger<int32> | null

occupiedThreshnumber<double> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originnumber<double>[] | null

Items: 3 to 3

resolutionnumber<float> | null

sizeBytesinteger<int64> | null

uploadStateenum<string>

Available options: UNKNOWN, PENDING, PROCESSING, READY

uploadedboolean | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

warningMsgstring | null