Skip to main content

Load Map in Roobt

POST 
/maps/load/:mapId

The Load Map in Robot request allows authenticated users to load a map into an ANSCER ROBOT. This request can only be accessed by users with the appropriate permissions, such as an administrator or developer.

To use this request, you need to provide the map's ID in the request URL.

Once ANSCER ANYA receives the request, it will verify that the specified map exist in the system and are compatible to load. If everything checks out, desired map will be loaded in the robot, which will then begin using it for navigation and other tasks.

It's important to note that loading a map into a robot may take some time, depending on the size of the map and the speed of the robot's network connection.

This request is useful for loading maps into ANSCER ROBOTS, such as when a robot needs to navigate a new facility or warehouse. It's important to ensure that the map being loaded is related to that particular environment

Request​

Path Parameters

    mapId stringrequired

    The ID of the map to load.

Responses​

Map loaded

Schema
    _id uuid
    name string

    Possible values: >= 3 characters and <= 50 characters

    isActive boolean
    properties object
    origin object
    position objectrequired
    x doublerequired
    y doublerequired
    z doublerequired
    orientation objectrequired
    x doublerequired
    y doublerequired
    z doublerequired
    w doublerequired
    width double
    height double
    resolution double
    previewUrl uri
    createdBy object

    The user who created this map

    _id string
    name string
    email email
    updatedBy object

    The user who last updated this map

    _id string
    name string
    email email
    createdAt date-time

    The date and time this user was created

    updatedAt date-time

    The date and time this user was last updated

Loading...