Skip to content

Find waypoint runs by route run

Find all waypoint runs for a given route run.

POST/api/robot/findWaypointRunsByRouteRun

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).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request to find waypoint runs for a given route run.

routeRunUuidstring<RUUID> | nullbodyrequired

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Response

200 OK

application/json · object

Response containing the waypoint runs for a route run.

errorboolean | null
errorMsgstring | null
warningMsgstring | null
waypointRunsobject[] | null

List of waypoint runs for the route run

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"