Robot

Deploy robot

Deploy the robot to a mapped point at its location

POST/api/robot/deploy

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 deploy the robot to a mapped location.

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

navTypeenum<string>body

Available options: ROUTE, PATROL, WAYPOINT, POSE

patrolUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

poseobjectbody

Show child attributes

orientationnumber<double>[] | nullbody

Items: 4 to 4

positionnumber<double>[] | nullbody

Items: 3 to 3

routeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

waypointUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/robot/deploy' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "navType": "ROUTE",
    "patrolUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "pose": {
      "orientation": [
        0
      ],
      "position": [
        0
      ]
    },
    "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }'

import requests

url = "https://api2.rhombussystems.com/api/robot/deploy"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "navType": "ROUTE",
    "patrolUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "pose": {
        "orientation": [
            0
        ],
        "position": [
            0
        ]
    },
    "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "waypointUuid": "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/deploy', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "navType": "ROUTE",
    "patrolUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "pose": {
      "orientation": [
        0
      ],
      "position": [
        0
      ]
    },
    "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "waypointUuid": "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",
              "navType": "ROUTE",
              "patrolUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "pose": {
                "orientation": [
                  0
                ],
                "position": [
                  0
                ]
              },
              "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/robot/deploy"))
            .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,
  "routeRunUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

200 OK

application/json · object

Response from deploying a robot.

errorboolean | null

errorMsgstring | null

routeRunUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

warningMsgstring | null