Skip to content

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

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

Retrieve the map assignment information for a device

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "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
createdAtMsinteger<int64> | null
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
has3dCloudboolean | null
hasCleanCloudboolean | null
headVersionUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

initiatedByDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

namestring | null
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"

mapVersionobject
Show child attributes
createdAtMsinteger<int64> | null
etagstring | null
freeThreshnumber<double> | null
has3dCloudboolean | null
hasCleanCloudboolean | null
initiatedByDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

mapUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

namestring | null
negateinteger<int32> | null
notesstring | null
occupiedThreshnumber<double> | null
orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originnumber<double>[] | null

Items: 3 to 3

parentVersionUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

resolutionnumber<float> | null
sessionUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

sizeBytesinteger<int64> | null
slamEngineenum<string>

Available options: UNKNOWN, SLAM_TOOLBOX, RTABMAP

sourceenum<string>

Available options: UNKNOWN, MAPPING_SESSION, ROBOT_MAINTENANCE, EDITOR, IMPORT

uploadStateenum<string>

Available options: UNKNOWN, PENDING, PROCESSING, READY

uploadedboolean | null
uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

versionUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

warningMsgstring | null