POST /mission/submitMission
Query Parameters
Parameter |
Required |
Type |
Description |
|---|---|---|---|
| mission_id | Yes | string | Text identifier to refer to this mission |
| mission_template | Yes | enum | Mission Template to describe the body data. Values are [“simple_navigation_mission”]. |
Request Body Schema
Element |
Required? |
Type |
Description |
|---|---|---|---|
| route | Yes | list[Point] | List of points the robot should travel |
| start_location | No | Point | If you would like to prepend the route with a specific starting location. Robot will travel from current location to this point before starting the route. |
| end_location | No | Point | If you would like to append to the route with a final ending location. Robot will travel to this location once completing the route. |
| iterations | No | integer | Default 1. Number of times the route should be performed. |
Point
Element |
Required? |
Type |
Description |
|---|---|---|---|
| x | Yes | number | X coordinate of a point |
| y | Yes | number | Y coordinate of a point |
| z | Yes | number | Z coordinate of a point |
If your robot is in a parking zone, you need it to travel to a
specific track entry location, do five laps on the track, and return to
a charging location. You would localize at the parking zone, set
start_location to the track entry, describe your route on the track with
iterations set to 5, then set the end_location as the charger.