Robot

Retrieve the robot's map assignment record.

A snapshot of the ancillary map data at the timeof when the map was assigned to the device.A device can only have one active assignment record. Assignment records are immutable. Only new records can be created

POST/api/robot/getMapAssignment

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

Retrieve the map assignment information for a device

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

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

import requests

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

{
  "assignmentTimeMs": 0,
  "assignmentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "error": false,
  "mapFilters": [
    {
      "mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "md5": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "type": "KEEPOUT",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "mapMeta": {
    "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

The robot map assignment information.

assignmentTimeMsinteger<int64> | null

assignmentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

errorboolean | null

errorMsgstring | null

mapFiltersobject[] | null

Show child attributes

mapUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

md5string | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

Available options: UNKNOWN, KEEPOUT

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

mapMetaobject

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