Mir250 Rest API 2.10.0

2.10.
0 MIR250 REST API

Overview
The REST API for the 2.10.0 interface of MIR250
Version information
Version : 2.10.0
Contact information
Contact Email : support@mir-robots.com
URI scheme
Host : mir.com/api
BasePath : /v2.0.0
Schemes : HTTP
Consumes
• application/json
Produces
• application/json
1
Security
Basic
To authenticate in the API a basic autentication has to be included in the header. It consists in a
string that is base64 encoded and it is formed by the username followed by a colon and the
password sha-256 encoded. Ex: BASE64( <username>:SHA-256( <password> ) )
An example header would look like this:
Content-Type:application/json
authorization:Basic
ZGlzdHJpYnV0b3I6NjJmMmYwZjFlZmYxMGQzMTUyYzk1ZjZmMDU5NjU3NmU0ODJiYjhlNDQ4MDY0MzNmNGNmOT
I5NzkyODM0YjAxNA==
SHA-256 encoder http://www.xorbin.com/tools/sha256-hash-calculator
Base64 encoded https://www.base64encode.org/
Type : basic
2
Paths
GET /actions
GET /actions
Description
Retrieve the list of action definitions
Parameters
Type Name Description Schema Default
Accept- enum (en_US, "UI_API_

DEFAULT_
Header Language Language header de_DE, es_ES, LANGUAGE
required da_DK, zh_CN) "
Authorizatio
enum
Header n Authorization header
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetAction_definiti
200 Successfully retrieve the specified element
ons
Invalid ordering or Invalid filters or Wrong output fields or Invalid
400 Error
limits
404 Not found Error
Tags
• Actions
3
POST /actions/{action_type}
POST /actions/{action_type}
Description
Add a new action definition with the specified action_type
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
action_type
Path The action_type to add the new resource to string
required
Action_defin
PostAction_definiti
Body ition The details of the action_definition
on
required
Responses
HTTP
Description Schema
Code
GetAction_definiti
201 The element has been created successfully
on
Argument error or Missing content type application/json on the
400 Error
header or Bad request or Invalid JSON
409 Duplicate entry Error
Tags
• Actions
4
GET /actions/{action_type}
GET /actions/{action_type}
Description
Retrieve the details about the action. It displays the parameters of the action and the limits for the
values among others
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
action_type
Path The action_type to search for string
required
Responses
HTTP
Description Schema
Code
GetAction_definiti
on
400 Error
limits
404 Not found Error
Tags
• Actions
5
POST /area_events
POST /area_events
Description
Add a new area event
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Area_events
Body The details of the area_events PostArea_events
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetArea_events
400 Error
Tags
• Area_events
6
GET /area_events
GET /area_events
Description
Retrieve the list of area events
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetArea_events
200 Successfully retrieved the list of elements
> array
400 Error
limits
404 Not found Error
Tags
• Area_events
7
GET /area_events/action_definitions
GET /area_events/action_definitions
Description
Retrieve definitions of area actions and their parameters
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetArea_action_de
finitions
400 Error
limits
404 Not found Error
Tags
• Action_definitions
• Area_events
8
GET /area_events/action_definitions/{action_type}
GET /area_events/action_definitions/{action_type}
Description
Retrieve the details about the action. It displays the parameters of the action and the limits for the
values among others
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
action_type
Path The action_type to search for string
required
Responses
HTTP
Description Schema
Code
GetArea_action_de
finition
400 Error
limits
404 Not found Error
Tags
• Action_definitions
• Area_events
9
GET /area_events/definitions
GET /area_events/definitions
Description
Retrieve definitions of areas and their actions
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetArea_events_d
efinitions
400 Error
limits
404 Not found Error
Tags
• Area_events
• Definitions
10
GET /area_events/{guid}
GET /area_events/{guid}
Description
Retrieve the details about the area event with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
Path The guid to search for string
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetArea_event
400 Error
limits
404 Not found Error
Tags
• Area_events
11
PUT /area_events/{guid}
PUT /area_events/{guid}
Description
Modify the values of the area event with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
Path The guid to modify string
required
Area_event
Body The new values of the area_event PutArea_event
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetArea_event
Invalid filters or Invalid JSON or Argument error or Missing content
400 Error
type application/json on the header or Bad request or No fields
404 Not found Error
Tags
• Area_events
12
DELETE /area_events/{guid}
DELETE /area_events/{guid}
Description
Erase the area event with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
Path The guid to delete string
required
Responses
HTTP
Description Schema
Code
204 The element has been deleted successfully No Content
400 Error
404 Not found Error
Tags
• Area_events
13
POST /bluetooth
POST /bluetooth
Description
Connect to the Bluetooth device with the given GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Bluetooth_st
PostBluetooth_stat
Body atus The details of the bluetooth_status
us
required
Responses
HTTP
Description Schema
Code
GetBluetooth_stat
us
400 Error
Tags
• Bluetooth
14
GET /bluetooth
GET /bluetooth
Description
Retrieve the status of the Bluetooth connection
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetBluetooth_stat
us
400 Error
limits
404 Not found Error
Tags
• Bluetooth
15
PUT /bluetooth
PUT /bluetooth
Description
Modify the outputs of the connected Bluetooth device
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Bluetooth_st
PutBluetooth_statu
Body atus The new values of the bluetooth_status
s
required
Responses
HTTP
Description Schema
Code
GetBluetooth_stat
200 The element has been modified successfully
us
400 Error
404 Not found Error
Tags
• Bluetooth
16
DELETE /bluetooth
DELETE /bluetooth
Description
Disconnect the Bluetooth device
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Bluetooth
17
POST /bluetooth/scan
POST /bluetooth/scan
Description
Retrieve the list of discovered devices
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetBluetooth
400 Error
Tags
• Bluetooth
• Scan
18
GET /bluetooth/scan
GET /bluetooth/scan
Description
Start the discovery of Bluetooth devices
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetBluetooth >
array
400 Error
limits
404 Not found Error
Tags
• Bluetooth
• Scan
19
POST /bluetooth_relays
POST /bluetooth_relays
Description
Add a new Bluetooth device
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Bluetooth_re
PostBluetooth_rela
Body lays The details of the bluetooth_relays
ys
required
Responses
HTTP
Description Schema
Code
GetBluetooth_rela
ys
400 Error
Tags
• Bluetooth_relays
20
GET /bluetooth_relays
GET /bluetooth_relays
Description
Retrieve the list of configured Bluetooth devices
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetBluetooth_rela
ys > array
400 Error
limits
404 Not found Error
Tags
21
GET /bluetooth_relays/{guid}
GET /bluetooth_relays/{guid}
Description
Retrieve the details about the Bluetooth device with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetBluetooth_rela
y
400 Error
limits
404 Not found Error
Tags
22
PUT /bluetooth_relays/{guid}
PUT /bluetooth_relays/{guid}
Description
Modify the values of the Bluetooth device with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Bluetooth_re
PutBluetooth_rela
Body lay The new values of the bluetooth_relay
y
required
Responses
HTTP
Description Schema
Code
GetBluetooth_rela
y
400 Error
404 Not found Error
Tags
23
DELETE /bluetooth_relays/{guid}
DELETE /bluetooth_relays/{guid}
Description
Erase the Bluetooth device with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
24
POST /cart_calibrations
POST /cart_calibrations
Description
Add a new cart calibration
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Cart_calibra
PostCart_calibratio
Body tions The details of the cart_calibrations
ns
required
Responses
HTTP
Description Schema
Code
GetCart_calibratio
ns
400 Error
Tags
• Cart_calibrations
25
GET /cart_calibrations
GET /cart_calibrations
Description
Retrieve the list of cart calibrations
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetCart_calibratio
ns > array
400 Error
limits
404 Not found Error
Tags
26
GET /cart_calibrations/{guid}
GET /cart_calibrations/{guid}
Description
Retrieve the details about the cart calibration with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetCart_calibratio
n
400 Error
limits
404 Not found Error
Tags
27
PUT /cart_calibrations/{guid}
PUT /cart_calibrations/{guid}
Description
Modify the values of the cart calibration with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Cart_calibra
PutCart_calibratio
Body tion The new values of the cart_calibration
n
required
Responses
HTTP
Description Schema
Code
GetCart_calibratio
n
400 Error
404 Not found Error
Tags
28
DELETE /cart_calibrations/{guid}
DELETE /cart_calibrations/{guid}
Description
Erase the cart calibration with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
29
POST /cart_types
POST /cart_types
Description
Add a new cart type
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Cart_types
Body The details of the cart_types PostCart_types
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetCart_types
400 Error
Tags
• Cart_types
30
GET /cart_types
GET /cart_types
Description
Retrieve the list of cart types
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetCart_types >
array
400 Error
limits
404 Not found Error
Tags
• Cart_types
31
GET /cart_types/{guid}
GET /cart_types/{guid}
Description
Retrieve the details about the cart type with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetCart_type
400 Error
limits
404 Not found Error
Tags
• Cart_types
32
PUT /cart_types/{guid}
PUT /cart_types/{guid}
Description
Modify the values of the cart type with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Cart_type
Body The new values of the cart_type PutCart_type
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetCart_type
400 Error
404 Not found Error
Tags
• Cart_types
33
DELETE /cart_types/{guid}
DELETE /cart_types/{guid}
Description
Erase the cart type with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Cart_types
34
POST /carts
POST /carts
Description
Add a new cart
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Carts
Body The details of the carts PostCarts
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetCarts
400 Error
Tags
• Carts
35
GET /carts
GET /carts
Description
Retrieve the list of carts
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved the list of elements < GetCarts > array
400 Error
limits
404 Not found Error
Tags
• Carts
36
GET /carts/{guid}
GET /carts/{guid}
Description
Retrieve the details about the cart with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetCart
400 Error
limits
404 Not found Error
Tags
• Carts
37
PUT /carts/{guid}
PUT /carts/{guid}
Description
Modify the values of the cart with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Cart
Body The new values of the cart PutCart
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetCart
400 Error
404 Not found Error
Tags
• Carts
38
DELETE /carts/{guid}
DELETE /carts/{guid}
Description
Erase the cart with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Carts
39
POST /dashboards
POST /dashboards
Description
Add a new dashboard
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Dashboards
Body The details of the dashboards PostDashboards
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetDashboards
400 Error
Tags
• Dashboards
40
GET /dashboards
GET /dashboards
Description
Retrieve the list of dashboards
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetDashboards >
array
400 Error
limits
404 Not found Error
Tags
• Dashboards
41
POST /dashboards/{dashboard_id}/widgets
POST /dashboards/{dashboard_id}/widgets
Description
Add a new widget to the dashboard with the specified dashboard ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
dashboard_i
The dashboard_id to add the new resource
Path d string
to
required
Dashboard_
PostDashboard_wi
Body widgets The details of the dashboard_widgets
dgets
required
Responses
HTTP
Description Schema
Code
GetDashboard_wi
dgets
400 Error
Tags
• Dashboards
• Widgets
42
GET /dashboards/{dashboard_id}/widgets
GET /dashboards/{dashboard_id}/widgets
Description
Retrieve the list of widgets of the dashboard with the specified dashboard ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
dashboard_i
Path d The dashboard_id to search for string
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetDashboard_wi
dgets > array
400 Error
limits
404 Not found Error
Tags
• Dashboards
• Widgets
43
GET /dashboards/{dashboard_id}/widgets/{guid}
GET /dashboards/{dashboard_id}/widgets/{guid}
Description
Retrieve the details about the widget with the specified GUID in the dashboard with the specified
dashboard ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
dashboard_i
Path d The dashboard_id to search for string
required
guid
required
Responses
HTTP
Description Schema
Code
GetDashboard_wi
dget
400 Error
limits
404 Not found Error
Tags
• Dashboards
• Widgets
44
PUT /dashboards/{dashboard_id}/widgets/{guid}
PUT /dashboards/{dashboard_id}/widgets/{guid}
Description
Modify the values of the widget with the specified GUID in the dashboard with the specified
dashboard ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
dashboard_i
Path d The dashboard_id to modify string
required
guid
required
Dashboard_
PutDashboard_wi
Body widget The new values of the dashboard_widget
dget
required
Responses
HTTP
Description Schema
Code
GetDashboard_wi
dget
400 Error
404 Not found Error
Tags
• Dashboards
• Widgets
45
DELETE /dashboards/{dashboard_id}/widgets/{guid}
DELETE /dashboards/{dashboard_id}/widgets/{guid}
Description
Erase the widget with the specified GUID from the dashboard with the specified dashboard ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
dashboard_i
Path d The dashboard_id to delete string
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Dashboards
• Widgets
46
GET /dashboards/{guid}
GET /dashboards/{guid}
Description
Retrieve the details of the dashboard with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetDashboard
400 Error
limits
404 Not found Error
Tags
• Dashboards
47
PUT /dashboards/{guid}
PUT /dashboards/{guid}
Description
Modify the values of the dashboard with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Dashboard
Body The new values of the dashboard PutDashboard
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetDashboard
400 Error
404 Not found Error
Tags
• Dashboards
48
DELETE /dashboards/{guid}
DELETE /dashboards/{guid}
Description
Erase the dashboard with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Dashboards
49
POST /docking_offsets
POST /docking_offsets
Description
Add a new docking offset. The only positions that can have docking offsets are Charging stations, V
markers and VL markers
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Docking_offs
PostDocking_offset
Body ets The details of the docking_offsets
s
required
Responses
HTTP
Description Schema
Code
GetDocking_offset
s
400 Error
Tags
• Docking_offsets
50
GET /docking_offsets
GET /docking_offsets
Description
Retrieve the list of docking offsets
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetDocking_offset
s > array
400 Error
limits
404 Not found Error
Tags
• Docking_offsets
51
GET /docking_offsets/shelfs
GET /docking_offsets/shelfs
Description
Retrieve the list of docking offsets
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
s_no_pos > array
400 Error
limits
404 Not found Error
Tags
• Docking_offsets
• Shelfs
52
GET /docking_offsets/types
GET /docking_offsets/types
Description
Retrieve a list of possible position types
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
_types > array
400 Error
limits
404 Not found Error
Tags
• Docking_offsets
• Types
53
GET /docking_offsets/types/{id}
GET /docking_offsets/types/{id}
Description
Retrieve the details about the position type with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to search for integer (int32)
required
Responses
HTTP
Description Schema
Code
GetDocking_offset
_type
400 Error
limits
404 Not found Error
Tags
• Docking_offsets
• Types
54
GET /docking_offsets/{guid}
GET /docking_offsets/{guid}
Description
Retrieve the details of the docking offset with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetDocking_offset
400 Error
limits
404 Not found Error
Tags
• Docking_offsets
55
PUT /docking_offsets/{guid}
PUT /docking_offsets/{guid}
Description
Modify the values of the docking offset with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Docking_offs
Body et The new values of the docking_offset PutDocking_offset
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetDocking_offset
400 Error
404 Not found Error
Tags
• Docking_offsets
56
DELETE /docking_offsets/{guid}
DELETE /docking_offsets/{guid}
Description
Erase the docking offset with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Docking_offsets
57
POST /elevator_floors
POST /elevator_floors
Description
Add a new elevator floor to the fleet
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Elevator_flo
PostElevator_floor
Body ors The details of the elevator_floors
s
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetElevator_floors
400 Error
Tags
• Elevator_floors
58
GET /elevator_floors
GET /elevator_floors
Description
Retrieve the list of elevator floors in the fleet
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetElevator_floors
> array
400 Error
limits
404 Not found Error
Tags
• Elevator_floors
59
GET /elevator_floors/{guid}
GET /elevator_floors/{guid}
Description
Retrieve the details about the specified elevator floor
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetElevator_floor
400 Error
limits
404 Not found Error
Tags
• Elevator_floors
60
PUT /elevator_floors/{guid}
PUT /elevator_floors/{guid}
Description
Modify the values of the specified elevator floor
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Elevator_flo
Body or The new values of the elevator_floor PutElevator_floor
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetElevator_floor
400 Error
404 Not found Error
Tags
• Elevator_floors
61
DELETE /elevator_floors/{guid}
DELETE /elevator_floors/{guid}
Description
Delete the specified elevator floor
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Elevator_floors
62
GET /elevator_status
GET /elevator_status
Description
Retrieve run-time info from all elevators on the fleet
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetElevator_status
> array
400 Error
limits
404 Not found Error
Tags
• Elevator_status
63
POST /elevators
POST /elevators
Description
Add a new elevator to the fleet
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Elevators
Body The details of the elevators PostElevators
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetElevators
400 Error
Tags
• Elevators
64
GET /elevators
GET /elevators
Description
Retrieve a list of elevators in the fleet
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetElevators >
array
400 Error
limits
404 Not found Error
Tags
• Elevators
65
GET /elevators/{guid}
GET /elevators/{guid}
Description
Retrieve the details about the elevator with the specified guid
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetElevator
400 Error
limits
404 Not found Error
Tags
• Elevators
66
PUT /elevators/{guid}
PUT /elevators/{guid}
Description
Modify the values of the elevator with the specified guid
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Elevator
Body The new values of the elevator PutElevator
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetElevator
400 Error
404 Not found Error
Tags
• Elevators
67
DELETE /elevators/{guid}
DELETE /elevators/{guid}
Description
Delete the elevator with the specified guid
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Elevators
68
GET /elevators/{guid}/cmd_check_server
GET /elevators/{guid}/cmd_check_server
Description
Check if the server provides expected methods and variables.
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetElevator_cmd_
check_server
400 Error
limits
404 Not found Error
Tags
• Cmd_check_server
• Elevators
69
POST /elevators/{guid}/cmd_control
POST /elevators/{guid}/cmd_control
Description
Request a control of the elevator.
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
Path The guid to add the new resource to string
required
Elevator_cm
PostElevator_cmd_
Body d_control The details of the elevator_cmd_control
control
required
Responses
HTTP
Description Schema
Code
GetElevator_cmd_
control
400 Error
Tags
• Cmd_control
• Elevators
70
POST /elevators/{guid}/cmd_door
POST /elevators/{guid}/cmd_door
Description
Request the elevator to open a door.
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Elevator_cm
PostElevator_cmd_
Body d_door The details of the elevator_cmd_door
door
required
Responses
HTTP
Description Schema
Code
GetElevator_cmd_
door
400 Error
Tags
• Cmd_door
• Elevators
71
POST /elevators/{guid}/cmd_floor
POST /elevators/{guid}/cmd_floor
Description
Request the elevator to go the a floor and open the door.
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Elevator_cm
PostElevator_cmd_
Body d_floor The details of the elevator_cmd_floor
floor
required
Responses
HTTP
Description Schema
Code
GetElevator_cmd_f
loor
400 Error
Tags
• Cmd_floor
• Elevators
72
GET /elevators/{guid}/opcua_scanner
GET /elevators/{guid}/opcua_scanner
Description
Retrieve the list of available namespaces on specified Opc UA server
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetElevator_opcua
_scanner
400 Error
limits
404 Not found Error
Tags
• Elevators
• Opcua_scanner
73
POST /factory_reset
POST /factory_reset
Description
Clean and migrate the database. Keep hardware configurations
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Factory_rese
Body t The details of the factory_reset PostFactory_reset
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetFactory_reset
400 Error
Tags
• Factory_reset
74
POST /footprints
POST /footprints
Description
Add new footprint to the database
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Footprints
Body The details of the footprints PostFootprints
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetFootprints
400 Error
Tags
• Footprints
75
GET /footprints
GET /footprints
Description
Retrieve a list of footprints currently stored
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetFootprints >
array
400 Error
limits
404 Not found Error
Tags
• Footprints
76
GET /footprints/{guid}
GET /footprints/{guid}
Description
Retrieve information about a footprint with specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetFootprint
400 Error
limits
404 Not found Error
Tags
• Footprints
77
PUT /footprints/{guid}
PUT /footprints/{guid}
Description
Modify a footprint with a specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Footprint
Body The new values of the footprint PutFootprint
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetFootprint
400 Error
404 Not found Error
Tags
• Footprints
78
DELETE /footprints/{guid}
DELETE /footprints/{guid}
Description
Delete with a specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Footprints
79
GET /hook/brake
GET /hook/brake
Description
Retrieve the state of the Hook brake
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetHook_brake
400 Error
limits
404 Not found Error
Tags
• Brake
• Hook
80
PUT /hook/brake
PUT /hook/brake
Description
Activate or release the Hook brake
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Hook_brake
Body The new values of the hook_brake PutHook_brake
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetHook_brake
400 Error
404 Not found Error
Tags
• Brake
• Hook
81
GET /hook/gripper
GET /hook/gripper
Description
Retrieve the state of the Hook gripper
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetHook_gripper
400 Error
limits
404 Not found Error
Tags
• Gripper
• Hook
82
PUT /hook/gripper
PUT /hook/gripper
Description
Open or close the Hook gripper
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Hook_grippe
Body r The new values of the hook_gripper PutHook_gripper
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetHook_gripper
400 Error
404 Not found Error
Tags
• Gripper
• Hook
83
GET /hook/height
GET /hook/height
Description
Retrieve the height of the Hook
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetHook_height
400 Error
limits
404 Not found Error
Tags
• Height
• Hook
84
PUT /hook/height
PUT /hook/height
Description
Modify the height of the Hook
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Hook_height
Body The new values of the hook_height PutHook_height
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetHook_height
400 Error
404 Not found Error
Tags
• Height
• Hook
85
GET /hook/status
GET /hook/status
Description
Retrieve the extended status of the Hook
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetHook
400 Error
limits
404 Not found Error
Tags
• Hook
• Status
86
GET /hw/export
GET /hw/export
Description
Download a file containing the hardware configuration of the robot
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetHw_config_exp
ort
400 Error
limits
404 Not found Error
Tags
• Export
• Hw
87
POST /hw/import
POST /hw/import
Description
Import the hardware configuration contained in the file into the robot
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Hw_config_i
PostHw_config_im
Body mport The details of the hw_config_import
port
required
Responses
HTTP
Description Schema
Code
GetHw_config_imp
ort
400 Error
Tags
• Hw
• Import
88
POST /io_modules
POST /io_modules
Description
Add a new IO module
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Io_modules
Body The details of the io_modules PostIo_modules
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetIo_modules
400 Error
Tags
• Io_modules
89
GET /io_modules
GET /io_modules
Description
Retrieve the list of configured IO modules
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetIo_modules >
array
400 Error
limits
404 Not found Error
Tags
• Io_modules
90
GET /io_modules/{guid}
GET /io_modules/{guid}
Description
Retrieve the details about a IO device with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetIo_module
400 Error
limits
404 Not found Error
Tags
• Io_modules
91
PUT /io_modules/{guid}
PUT /io_modules/{guid}
Description
Modify the values of the IO device with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Io_module
Body The new values of the io_module PutIo_module
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetIo_module
400 Error
404 Not found Error
Tags
• Io_modules
92
DELETE /io_modules/{guid}
DELETE /io_modules/{guid}
Description
Erase the IO device with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Io_modules
93
POST /io_modules/{guid}/status
POST /io_modules/{guid}/status
Description
Connect to theIO module with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Io_module_s
PostIo_module_sta
Body tatus The details of the io_module_status
tus
required
Responses
HTTP
Description Schema
Code
GetIo_module_stat
us
400 Error
Tags
• Io_modules
• Status
94
GET /io_modules/{guid}/status
GET /io_modules/{guid}/status
Description
Retrieve the status of the connection to the IO module with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetIo_module_stat
us
400 Error
limits
404 Not found Error
Tags
• Io_modules
• Status
95
PUT /io_modules/{guid}/status
PUT /io_modules/{guid}/status
Description
Modify the outputs of the connected IO module with specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Io_module_s
PutIo_module_stat
Body tatus The new values of the io_module_status
us
required
Responses
HTTP
Description Schema
Code
GetIo_module_stat
us
400 Error
404 Not found Error
Tags
• Io_modules
• Status
96
DELETE /io_modules/{guid}/status
DELETE /io_modules/{guid}/status
Description
Disconnect from the IO module with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Io_modules
• Status
97
POST /log/error_reports
POST /log/error_reports
Description
Generate a new error report. This will record the 30s previous to this call in a file.
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Error_report
Body s The details of the error_reports PostError_reports
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetError_reports
400 Error
Tags
• Error_reports
• Log
98
GET /log/error_reports
GET /log/error_reports
Description
Retrieve the list of error reports
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetError_reports
400 Error
limits
404 Not found Error
Tags
• Error_reports
• Log
99
DELETE /log/error_reports
DELETE /log/error_reports
Description
Erase ALL the error reports
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Error_reports
• Log
100
GET /log/error_reports/{id}
GET /log/error_reports/{id}
Description
Retrieve the details about the error report with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetError_report
400 Error
limits
404 Not found Error
Tags
• Error_reports
• Log
101
DELETE /log/error_reports/{id}
DELETE /log/error_reports/{id}
Description
Erase the error report with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to delete integer (int32)
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Error_reports
• Log
102
GET /log/error_reports/{id}/download
GET /log/error_reports/{id}/download
Description
Download the file containing the error report with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
Responses
HTTP
Description Schema
Code
GetError_report_d
ownload
400 Error
limits
404 Not found Error
Tags
• Download
• Error_reports
• Log
103
POST /maps
POST /maps
Description
Add a new map
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Maps
Body The details of the maps PostMaps
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetMaps
400 Error
Tags
• Maps
104
GET /maps
GET /maps
Description
Retrieve the list of maps
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved the list of elements < GetMaps > array
400 Error
limits
404 Not found Error
Tags
• Maps
105
GET /maps/{guid}
GET /maps/{guid}
Description
Retrieve the details about the map with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetMap
400 Error
limits
404 Not found Error
Tags
• Maps
106
PUT /maps/{guid}
PUT /maps/{guid}
Description
Modify the values of the map with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Map
Body The new values of the map PutMap
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetMap
400 Error
404 Not found Error
Tags
• Maps
107
DELETE /maps/{guid}
DELETE /maps/{guid}
Description
Erase the map with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Maps
108
GET /maps/{map_id}/area_events
GET /maps/{map_id}/area_events
Description
Retrieve the list of area events that belong to the map with the specified map ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
map_id
Path The map_id to search for string
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetMap_area_eve
nt > array
400 Error
limits
404 Not found Error
Tags
• Area_events
• Maps
109
GET /maps/{map_id}/path_guides
GET /maps/{map_id}/path_guides
Description
Retrieve the list of path guides that belong to the map with the specified map ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
map_id
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetMap_path_guid
es > array
400 Error
limits
404 Not found Error
Tags
• Maps
• Path_guides
110
GET /maps/{map_id}/paths
GET /maps/{map_id}/paths
Description
Retrieve the list of paths that belong to the map with the specified map ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
map_id
required
Responses
HTTP
Description Schema
Code
< GetMap_paths >
array
400 Error
limits
404 Not found Error
Tags
• Maps
• Paths
111
GET /maps/{map_id}/positions
GET /maps/{map_id}/positions
Description
Retrieve the list of positions that belong to the map with the specified map ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
map_id
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetMap_positions
> array
400 Error
limits
404 Not found Error
Tags
• Maps
• Positions
112
POST /mission_groups
POST /mission_groups
Description
Add a new mission group
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Mission_gro
PostMission_group
Body ups The details of the mission_groups
s
required
Responses
HTTP
Description Schema
Code
GetMission_group
s
400 Error
Tags
• Mission_groups
113
GET /mission_groups
GET /mission_groups
Description
Retrieve the list of mission groups
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetMission_group
s > array
400 Error
limits
404 Not found Error
Tags
• Mission_groups
114
GET /mission_groups/{group_id}/missions
GET /mission_groups/{group_id}/missions
Description
Retrieve the list of missions that belong to the group with the specified group ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
group_id
Path The group_id to search for string
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetGroup_mission
s > array
400 Error
limits
404 Not found Error
Tags
• Mission_groups
• Missions
115
GET /mission_groups/{guid}
GET /mission_groups/{guid}
Description
Retrieve the details about the mission group with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetMission_group
400 Error
limits
404 Not found Error
Tags
• Mission_groups
116
PUT /mission_groups/{guid}
PUT /mission_groups/{guid}
Description
Modify the values of the mission group with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Mission_gro
Body up The new values of the mission_group PutMission_group
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetMission_group
400 Error
404 Not found Error
Tags
• Mission_groups
117
DELETE /mission_groups/{guid}
DELETE /mission_groups/{guid}
Description
Erase the mission group with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Mission_groups
118
GET /mission_groups/{mission_group_id}/actions
GET /mission_groups/{mission_group_id}/actions
Description
Retrieve the list of action definitions from the mission group with the specified mission group ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
mission_gro
Path up_id The mission_group_id to search for string
required
Responses
HTTP
Description Schema
Code
GetGroup_action_
definition
400 Error
limits
404 Not found Error
Tags
• Actions
• Mission_groups
119
POST /mission_queue
POST /mission_queue
Description
Add a new mission to the mission queue. The mission will always go to the end of the queue
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Mission_que
PostMission_queu
Body ues The details of the mission_queues
es
required
Responses
HTTP
Description Schema
Code
GetMission_queue
s
400 Error
Tags
• Mission_queue
120
GET /mission_queue
GET /mission_queue
Description
Retrieve the list of missions in the queue. Finished, failed, pending and executing missions will be
displayed here
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetMission_queue
s > array
400 Error
limits
404 Not found Error
Tags
• Mission_queue
121
DELETE /mission_queue
DELETE /mission_queue
Description
Abort all the pending and executing missions from the mission queue
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Mission_queue
122
GET /mission_queue/{id}
GET /mission_queue/{id}
Description
Retrieve the details about the mission with the specified ID in the mission queue
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetMission_queue
400 Error
limits
404 Not found Error
Tags
• Mission_queue
123
PUT /mission_queue/{id}
PUT /mission_queue/{id}
Description
Modify the values of the mission with the specified ID in the mission queue
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to modify integer (int32)
required
Mission_que
Body ue The new values of the mission_queue PutMission_queue
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetMission_queue
400 Error
404 Not found Error
Tags
• Mission_queue
124
DELETE /mission_queue/{id}
DELETE /mission_queue/{id}
Description
Abort the mission with the specified ID in the mission queue
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to delete integer (int32)
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Mission_queue
125
GET /mission_queue/{mission_queue_id}/actions
GET /mission_queue/{mission_queue_id}/actions
Description
Retrieve the list of actions from the mission with the specified ID in the mission queue
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
mission_que
Path ue_id The mission_queue_id to search for integer (int32)
required
Responses
HTTP
Description Schema
Code
GetMission_queue
_actions
400 Error
limits
404 Not found Error
Tags
• Actions
• Mission_queue
126
GET /mission_queue/{mission_queue_id}/actions/{id}
GET /mission_queue/{mission_queue_id}/actions/{id}
Description
Retrieve the details about the action with the specified ID from the mission with the specified ID in
the mission queue
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
mission_que
Path ue_id The mission_queue_id to search for integer (int32)
required
Responses
HTTP
Description Schema
Code
GetMission_queue
_action
400 Error
limits
404 Not found Error
Tags
• Actions
• Mission_queue
127
POST /missions
POST /missions
Description
Add a new mission
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Missions
Body The details of the missions PostMissions
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetMissions
400 Error
Tags
• Missions
128
GET /missions
GET /missions
Description
Retrieve the list of missions
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetMissions >
array
400 Error
limits
404 Not found Error
Tags
• Missions
129
GET /missions/{guid}
GET /missions/{guid}
Description
Retrieve the details about the mission with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetMission
400 Error
limits
404 Not found Error
Tags
• Missions
130
PUT /missions/{guid}
PUT /missions/{guid}
Description
Modify the values of the mission with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Mission
Body The new values of the mission PutMission
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetMission
400 Error
404 Not found Error
Tags
• Missions
131
DELETE /missions/{guid}
DELETE /missions/{guid}
Description
Erase the mission with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Missions
132
GET /missions/{guid}/definition
GET /missions/{guid}/definition
Description
Retrieve the mission with the specified GUID as an action definition that can be inserted in another
mission
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetMission_definit
ion > array
400 Error
limits
404 Not found Error
Tags
• Definition
• Missions
133
POST /missions/{mission_id}/actions
POST /missions/{mission_id}/actions
Description
Add a new action to the mission with the specified mission ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
mission_id
Path The mission_id to add the new resource to string
required
Mission_acti
PostMission_actio
Body ons The details of the mission_actions
ns
required
Responses
HTTP
Description Schema
Code
GetMission_action
s
400 Error
Tags
• Actions
• Missions
134
GET /missions/{mission_id}/actions
GET /missions/{mission_id}/actions
Description
Retrieve the list of actions that belong to the mission with the specified mission ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
mission_id
Path The mission_id to search for string
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetMission_action
s > array
400 Error
limits
404 Not found Error
Tags
• Actions
• Missions
135
GET /missions/{mission_id}/actions/{guid}
GET /missions/{mission_id}/actions/{guid}
Description
Retrieve the details about the action with the specified GUID that belongs to the mission with the
specified mission ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
mission_id
Path The mission_id to search for string
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetMission_action
400 Error
limits
404 Not found Error
Tags
• Actions
• Missions
136
PUT /missions/{mission_id}/actions/{guid}
PUT /missions/{mission_id}/actions/{guid}
Description
Modify the values of the action with the specified GUID that belongs to the mission with the
specified mission ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
mission_id
Path The mission_id to modify string
required
Mission_acti
Body on The new values of the mission_action PutMission_action
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetMission_action
400 Error
404 Not found Error
Tags
• Actions
• Missions
137
DELETE /missions/{mission_id}/actions/{guid}
DELETE /missions/{mission_id}/actions/{guid}
Description
Erase the action with the specified GUID from the mission with the specified mission ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
mission_id
Path The mission_id to delete string
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Actions
• Missions
138
GET /modbus
GET /modbus
Description
Retrieve the modbus registers linked to actions
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetModbus
400 Error
limits
404 Not found Error
Tags
• Modbus
139
POST /modbus/missions
POST /modbus/missions
Description
Create a new link between a coil and a mission
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Modbus_mis
PostModbus_missi
Body sions The details of the modbus_missions
ons
required
Responses
HTTP
Description Schema
Code
GetModbus_missio
ns
400 Error
Tags
• Missions
• Modbus
140
GET /modbus/missions
GET /modbus/missions
Description
Retrieve the list of coils that can trigger a mission
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetModbus_missio
ns > array
400 Error
limits
404 Not found Error
Tags
• Missions
• Modbus
141
GET /modbus/missions/{guid}
GET /modbus/missions/{guid}
Description
Retrieve the details about the mission linked with the coil
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetModbus_missio
n
400 Error
limits
404 Not found Error
Tags
• Missions
• Modbus
142
PUT /modbus/missions/{guid}
PUT /modbus/missions/{guid}
Description
Modify the values of the modbus mission with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Modbus_mis
PutModbus_missio
Body sion The new values of the modbus_mission
n
required
Responses
HTTP
Description Schema
Code
GetModbus_missio
n
400 Error
404 Not found Error
Tags
• Missions
• Modbus
143
DELETE /modbus/missions/{guid}
DELETE /modbus/missions/{guid}
Description
Delete the specified ID on the the modbus mission table
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Missions
• Modbus
144
GET /modbus/{id}
GET /modbus/{id}
Description
Retrieve the modbus registers linked to an action
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to search for string
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetModbu
400 Error
limits
404 Not found Error
Tags
• Modbus
145
POST /path_guides
POST /path_guides
Description
Add a new path guide
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Path_guides
Body The details of the path_guides PostPath_guides
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetPath_guides
400 Error
Tags
• Path_guides
146
GET /path_guides
GET /path_guides
Description
Retrieve the list of path guides
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetPath_guides >
array
400 Error
limits
404 Not found Error
Tags
• Path_guides
147
GET /path_guides/{guid}
GET /path_guides/{guid}
Description
Retrieve the path guide with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetPath_guide
400 Error
limits
404 Not found Error
Tags
• Path_guides
148
PUT /path_guides/{guid}
PUT /path_guides/{guid}
Description
Modify the values of the path guide with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Path_guide
Body The new values of the path_guide PutPath_guide
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetPath_guide
400 Error
404 Not found Error
Tags
• Path_guides
149
DELETE /path_guides/{guid}
DELETE /path_guides/{guid}
Description
Erase the path guide with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Path_guides
150
GET /path_guides/{path_guide_guid}/options
GET /path_guides/{path_guide_guid}/options
Description
Retrieve the list of allowed start/via/goal options for the selected path guide
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
path_guide_g
Path uid The path_guide_guid to search for string
required
Responses
HTTP
Description Schema
Code
GetPath_guide_opt
ions
400 Error
limits
404 Not found Error
Tags
• Options
• Path_guides
151
POST /path_guides/{path_guide_guid}/positions
POST /path_guides/{path_guide_guid}/positions
Description
Add a new position to the path guide with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
path_guide_g
The path_guide_guid to add the new
Path uid string
resource to
required
Path_guide_
PostPath_guide_po
Body positions The details of the path_guide_positions
sitions
required
Responses
HTTP
Description Schema
Code
GetPath_guide_pos
itions
400 Error
Tags
• Path_guides
• Positions
152
GET /path_guides/{path_guide_guid}/positions
GET /path_guides/{path_guide_guid}/positions
Description
Retrieve the list of positions for the path guide with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
path_guide_g
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetPath_guide_pos
itions > array
400 Error
limits
404 Not found Error
Tags
• Path_guides
• Positions
153
GET /path_guides/{path_guide_guid}/positions/{guid}
GET /path_guides/{path_guide_guid}/positions/{guid}
Description
Retrieve the position with the specified GUID from the path guide with the specified path guide
GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
path_guide_g
required
Responses
HTTP
Description Schema
Code
GetPath_guide_pos
ition
400 Error
limits
404 Not found Error
Tags
• Path_guides
• Positions
154
PUT /path_guides/{path_guide_guid}/positions/{guid}
PUT /path_guides/{path_guide_guid}/positions/{guid}
Description
Modify the values of the position with the specified GUID from the path guide with the specified
path guide GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
path_guide_g
Path uid The path_guide_guid to modify string
required
Path_guide_
PutPath_guide_pos
Body position The new values of the path_guide_position
ition
required
Responses
HTTP
Description Schema
Code
GetPath_guide_pos
ition
400 Error
404 Not found Error
Tags
• Path_guides
• Positions
155
DELETE
/path_guides/{path_guide_guid}/positions/{guid}
DELETE /path_guides/{path_guide_guid}/positions/{guid}
Description
Erase the position with the specified GUID from the path guide with the specified path guide GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
path_guide_g
Path uid The path_guide_guid to delete string
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Path_guides
• Positions
156
POST /path_guides_positions
POST /path_guides_positions
Description
Add a new position in a path guide
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Path_guides_
PostPath_guides_p
Body positions The details of the path_guides_positions
ositions
required
Responses
HTTP
Description Schema
Code
GetPath_guides_po
sitions
400 Error
Tags
• Path_guides_positions
157
GET /path_guides_positions
GET /path_guides_positions
Description
Retrieve the list of positions used for path guides
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetPath_guides_po
sitions > array
400 Error
limits
404 Not found Error
Tags
158
GET /path_guides_positions/{guid}
GET /path_guides_positions/{guid}
Description
Retrieve the position for path guides with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetPath_guides_po
sition
400 Error
limits
404 Not found Error
Tags
159
PUT /path_guides_positions/{guid}
PUT /path_guides_positions/{guid}
Description
Modify the values of the position for path guides with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Path_guides_
PutPath_guides_po
Body position The new values of the path_guides_position
sition
required
Responses
HTTP
Description Schema
Code
GetPath_guides_po
sition
400 Error
404 Not found Error
Tags
160
DELETE /path_guides_positions/{guid}
DELETE /path_guides_positions/{guid}
Description
Erase the path guide position with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
161
POST /path_guides_precalc
POST /path_guides_precalc
Description
Start/stop precalculation of the specified path guide
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Path_guides_
PostPath_guides_p
Body precalc The details of the path_guides_precalc
recalc
required
Responses
HTTP
Description Schema
Code
GetPath_guides_pr
ecalc
400 Error
Tags
• Path_guides_precalc
162
GET /path_guides_precalc
GET /path_guides_precalc
Description
Retrieve the status of path guides precalculation
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetPath_guides_pr
ecalc
400 Error
limits
404 Not found Error
Tags
• Path_guides_precalc
163
POST /paths
POST /paths
Description
Add a new path
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Paths
Body The details of the paths PostPaths
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetPaths
400 Error
Tags
• Paths
164
GET /paths
GET /paths
Description
Retrieve the list of paths
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved the list of elements < GetPaths > array
400 Error
limits
404 Not found Error
Tags
• Paths
165
GET /paths/{guid}
GET /paths/{guid}
Description
Retrieve the path with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetPath
400 Error
limits
404 Not found Error
Tags
• Paths
166
PUT /paths/{guid}
PUT /paths/{guid}
Description
Modify the values of the path with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Path
Body The new values of the path PutPath
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetPath
400 Error
404 Not found Error
Tags
• Paths
167
DELETE /paths/{guid}
DELETE /paths/{guid}
Description
Erase the path with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Paths
168
GET /permissions/{guid}
GET /permissions/{guid}
Description
Retrieve the details about the permission with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetPermission
400 Error
limits
404 Not found Error
Tags
• Permissions
169
DELETE /permissions/{guid}
DELETE /permissions/{guid}
Description
Erase the permission with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Permissions
170
POST /position_transition_lists
POST /position_transition_lists
Description
Add a new position transition list
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Position_tra
PostPosition_trans
Body nsition_lists The details of the position_transition_lists
ition_lists
required
Responses
HTTP
Description Schema
Code
GetPosition_transi
tion_lists
400 Error
Tags
• Position_transition_lists
171
GET /position_transition_lists
GET /position_transition_lists
Description
Retrieve the list of position transition lists
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetPosition_transi
tion_lists
400 Error
limits
404 Not found Error
Tags
172
GET /position_transition_lists/{guid}
GET /position_transition_lists/{guid}
Description
Retrieve the details about the position transition list with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetPosition_transi
tion_list
400 Error
limits
404 Not found Error
Tags
173
PUT /position_transition_lists/{guid}
PUT /position_transition_lists/{guid}
Description
Modify the values of the position transition list with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Position_tra
The new values of the PutPosition_transi
Body nsition_list
position_transition_list tion_list
required
Responses
HTTP
Description Schema
Code
GetPosition_transi
tion_list
400 Error
404 Not found Error
Tags
174
DELETE /position_transition_lists/{guid}
DELETE /position_transition_lists/{guid}
Description
Erase the position transition list with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
175
GET /position_types
GET /position_types
Description
Retrieve a list of possible position types
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetPosition_types
> array
400 Error
limits
404 Not found Error
Tags
• Position_types
176
GET /position_types/{id}
GET /position_types/{id}
Description
Retrieve the details about the position type with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetPosition_type
400 Error
limits
404 Not found Error
Tags
• Position_types
177
POST /positions
POST /positions
Description
Add a new position
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Positions
Body The details of the positions PostPositions
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetPositions
400 Error
Tags
• Positions
178
GET /positions
GET /positions
Description
Retrieve the list of positions
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetPositions >
array
400 Error
limits
404 Not found Error
Tags
• Positions
179
GET /positions/{guid}
GET /positions/{guid}
Description
Retrieve the details about the position with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetPosition
400 Error
limits
404 Not found Error
Tags
• Positions
180
PUT /positions/{guid}
PUT /positions/{guid}
Description
Modify the values of the position with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Position
Body The new values of the position PutPosition
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetPosition
400 Error
404 Not found Error
Tags
• Positions
181
DELETE /positions/{guid}
DELETE /positions/{guid}
Description
Erase the position with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Positions
182
GET /positions/{parent_guid}/helper_positions
GET /positions/{parent_guid}/helper_positions
Description
Retrieve the list of helper positions for the position with the specified parent GUID. Only Charging
Stations, V markers, VL markers, Shelf and Trolley positions have helper positions
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
parent_guid
Path The parent_guid to search for string
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetHelper_positio
ns > array
400 Error
limits
404 Not found Error
Tags
• Helper_positions
• Positions
183
GET /positions/{pos_id}/docking_offsets
GET /positions/{pos_id}/docking_offsets
Description
Retrieve the details of the docking offset of the position with the specified position ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
pos_id
Path The pos_id to search for string
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetPos_docking_of
fsets > array
400 Error
limits
404 Not found Error
Tags
• Docking_offsets
• Positions
184
GET /registers
GET /registers
Description
Retrieve the list of PLC registers from the robot. Registers 1 to 100 are integers and registers 101-200
are float
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetRegisters >
array
400 Error
limits
404 Not found Error
Tags
• Registers
185
POST /registers/{id}
POST /registers/{id}
Description
Modify the value of the PLC register with the specified ID. Registers 1 to 100 are integers and
registers 101-200 are float. Even though this is not a standard use of the POST call it has been
included for compatibility purposes
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to add the new resource to integer (int32)
required
Register
Body The details of the register PostRegister
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetRegister
400 Error
Tags
• Registers
186
GET /registers/{id}
GET /registers/{id}
Description
Retrieve the value of the PLC register with the specified ID. Registers 1 to 100 are integers and
registers 101-200 are float
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetRegister
400 Error
limits
404 Not found Error
Tags
• Registers
187
PUT /registers/{id}
PUT /registers/{id}
Description
Modify the value of the PLC register with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to modify integer (int32)
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetRegister
400 Error
404 Not found Error
Tags
• Registers
188
GET /remote_support
GET /remote_support
Description
Retrieve the status of the remote support connection
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetRemote_suppor
t
400 Error
limits
404 Not found Error
Tags
• Remote_support
189
PUT /remote_support
PUT /remote_support
Description
Modify the remote support connection timeout
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Remote_sup
PutRemote_suppor
Body port The new values of the remote_support
t
required
Responses
HTTP
Description Schema
Code
GetRemote_suppor
t
400 Error
404 Not found Error
Tags
• Remote_support
190
GET /remote_support/log
GET /remote_support/log
Description
Retrieve the list with the actions performed by the remote support controller
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetRemote_suppor
t_log
400 Error
limits
404 Not found Error
Tags
• Log
• Remote_support
191
POST /robots
POST /robots
Description
Add information about other robots in the world. This is used by the Fleet manager to avoid robot
collisions
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Robots
Body The details of the robots PostRobots
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetRobots
400 Error
Tags
• Robots
192
POST /service_book
POST /service_book
Description
Add a service book note
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Service_boo
Body ks The details of the service_books PostService_books
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetService_books
400 Error
Tags
• Service_book
193
GET /service_book
GET /service_book
Description
Retrieve service book entries accessible by user
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetService_books
400 Error
limits
404 Not found Error
Tags
• Service_book
194
GET /service_book/{guid}
GET /service_book/{guid}
Description
Retrieve note with the GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetService_book
400 Error
limits
404 Not found Error
Tags
• Service_book
195
DELETE /service_book/{guid}
DELETE /service_book/{guid}
Description
Erase the note with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Service_book
196
POST /sessions
POST /sessions
Description
Add a new session
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Sessions
Body The details of the sessions PostSessions
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetSessions
400 Error
Tags
• Sessions
197
GET /sessions
GET /sessions
Description
Retrieve the list of sessions
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetSessions >
array
400 Error
limits
404 Not found Error
Tags
• Sessions
198
POST /sessions/import
POST /sessions/import
Description
Import the session contained in the file
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Session_imp
PostSession_impor
Body ort The details of the session_import
t
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetSession_import
400 Error
Tags
• Import
• Sessions
199
GET /sessions/import
GET /sessions/import
Description
Get progress of the running import
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSession_import
400 Error
limits
404 Not found Error
Tags
• Import
• Sessions
200
DELETE /sessions/import
DELETE /sessions/import
Description
Cancel currently running import
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Import
• Sessions
201
GET /sessions/{guid}
GET /sessions/{guid}
Description
Retrieve the details about the session with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSession
400 Error
limits
404 Not found Error
Tags
• Sessions
202
PUT /sessions/{guid}
PUT /sessions/{guid}
Description
Modify the values of the session with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Session
Body The new values of the session PutSession
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetSession
400 Error
404 Not found Error
Tags
• Sessions
203
DELETE /sessions/{guid}
DELETE /sessions/{guid}
Description
Erase the session with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Sessions
204
GET /sessions/{guid}/export
GET /sessions/{guid}/export
Description
Download a file containing the session with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSession_export
400 Error
limits
404 Not found Error
Tags
• Export
• Sessions
205
GET /sessions/{session_id}/elevator_floors
GET /sessions/{session_id}/elevator_floors
Description
Retrieve the list of elevator floors that belong to the session with the specified session ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
session_id
Path The session_id to search for string
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetSession_elevat
or_floors > array
400 Error
limits
404 Not found Error
Tags
• Elevator_floors
• Sessions
206
GET /sessions/{session_id}/elevators
GET /sessions/{session_id}/elevators
Description
Retrieve the list of elevators that belong to the session with the specified session ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
session_id
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetSession_elevat
ors > array
400 Error
limits
404 Not found Error
Tags
• Elevators
• Sessions
207
GET /sessions/{session_id}/maps
GET /sessions/{session_id}/maps
Description
Retrieve the list of maps that belong to the session with the specified session ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
session_id
required
Responses
HTTP
Description Schema
Code
< GetSession_maps
> array
400 Error
limits
404 Not found Error
Tags
• Maps
• Sessions
208
GET /sessions/{session_id}/missions
GET /sessions/{session_id}/missions
Description
Retrieve the list of missions that belong to the session with the specified session ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
session_id
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetSession_missio
ns > array
400 Error
limits
404 Not found Error
Tags
• Missions
• Sessions
209
GET /sessions/{session_id}/position_transition_lists
GET /sessions/{session_id}/position_transition_lists
Description
Retrieve the list of position transition lists that belong to the session with the specified session ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
session_id
required
Responses
HTTP
Description Schema
Code
GetPosition_transi
200 Successfully retrieve the specified element tion_list_from_sess
ion
400 Error
limits
404 Not found Error
Tags
• Sessions
210
GET /setting_groups
GET /setting_groups
Description
Retrieve a list with the settings groups
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetSetting_groups
> array
400 Error
limits
404 Not found Error
Tags
• Setting_groups
211
GET /setting_groups/{id}
GET /setting_groups/{id}
Description
Retrieve the details about the settings group with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSetting_group
400 Error
limits
404 Not found Error
Tags
• Setting_groups
212
GET /setting_groups/{settings_group_id}/settings
GET /setting_groups/{settings_group_id}/settings
Description
Retrieve the list of settings from the settings group with the specified settings group ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
settings_gro
Path up_id The settings_group_id to search for integer (int32)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetSetting_group_
settings > array
400 Error
limits
404 Not found Error
Tags
• Setting_groups
• Settings
213
GET
/setting_groups/{settings_group_id}/settings/advanced
GET /setting_groups/{settings_group_id}/settings/advanced
Description
Retrieve the list of advanced settings from the settings group with the specified settings group ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
settings_gro
Path up_id The settings_group_id to search for integer (int32)
required
Responses
HTTP
Description Schema
Code
<
GetSetting_group_
advanced_settings
> array
400 Error
limits
404 Not found Error
Tags
• Advanced
• Setting_groups
• Settings
214
GET /settings
GET /settings
Description
Retrieve a list with the settings
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetSettings >
array
400 Error
limits
404 Not found Error
Tags
• Settings
215
GET /settings/advanced
GET /settings/advanced
Description
Retrieve the list with the advanced settings
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetSettings_advan
ced > array
400 Error
limits
404 Not found Error
Tags
• Advanced
• Settings
216
GET /settings/advanced/{id}
GET /settings/advanced/{id}
Description
Retrieve the details of the advanced setting with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
Responses
HTTP
Description Schema
Code
GetSetting_advanc
ed
400 Error
limits
404 Not found Error
Tags
• Advanced
• Settings
217
PUT /settings/advanced/{id}
PUT /settings/advanced/{id}
Description
Modify the values of the advanced setting with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to modify string
required
Setting_adva
PutSetting_advanc
Body nced The new values of the setting_advanced
ed
required
Responses
HTTP
Description Schema
Code
GetSetting_advanc
ed
400 Error
404 Not found Error
Tags
• Advanced
• Settings
218
GET /settings/{id}
GET /settings/{id}
Description
Retrieve the details of the setting with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSetting
400 Error
limits
404 Not found Error
Tags
• Settings
219
PUT /settings/{id}
PUT /settings/{id}
Description
Modify the values of the setting with the specified ID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
id
Path The id to modify string
required
Setting
Body The new values of the setting PutSetting
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetSetting
400 Error
404 Not found Error
Tags
• Settings
220
POST /software/backups
POST /software/backups
Description
Create a new software backup
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetSoftware_back
ups
400 Error
Tags
• Backups
• Software
221
GET /software/backups
GET /software/backups
Description
Retrieve the list with all the software backups
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetSoftware_back
ups > array
400 Error
limits
404 Not found Error
Tags
• Backups
• Software
222
POST /software/backups/{guid}
POST /software/backups/{guid}
Description
If it exists a software backup with the specified GUID it will restore that backup. Otherwise, it will
create a software backup with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetSoftware_back
up
400 Error
Tags
• Backups
• Software
223
GET /software/backups/{guid}
GET /software/backups/{guid}
Description
Retrieve the details about the software backup with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetSoftware_back
up
400 Error
limits
404 Not found Error
Tags
• Backups
• Software
224
DELETE /software/backups/{guid}
DELETE /software/backups/{guid}
Description
Erase the software backup with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Backups
• Software
225
GET /software/logs
GET /software/logs
Description
Retrieve the list of software upgrade logs
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetSoftware_logs
> array
400 Error
limits
404 Not found Error
Tags
• Logs
• Software
226
GET /software/logs/{guid}
GET /software/logs/{guid}
Description
Retrieve the details about the software upgrade log with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSoftware_log
400 Error
limits
404 Not found Error
Tags
• Logs
• Software
227
POST /software/upgrades
POST /software/upgrades
Description
Upgrade with the provided upgrade file
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetSoftware_upgr
ades
400 Error
Tags
• Software
• Upgrades
228
GET /software/upgrades
GET /software/upgrades
Description
Retrieve a list of the software upgrade performed
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetSoftware_upgr
ades > array
400 Error
limits
404 Not found Error
Tags
• Software
• Upgrades
229
POST /software/upgrades/{guid}
POST /software/upgrades/{guid}
Description
Upgrade to the version of the upgrade file with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetSoftware_upgr
ade
400 Error
Tags
• Software
• Upgrades
230
GET /software/upgrades/{guid}
GET /software/upgrades/{guid}
Description
Retrieve the details of the software upgrade with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
GetSoftware_upgr
ade
400 Error
limits
404 Not found Error
Tags
• Software
• Upgrades
231
DELETE /software/upgrades/{guid}
DELETE /software/upgrades/{guid}
Description
Erase the upgrade file with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Software
• Upgrades
232
POST /sounds
POST /sounds
Description
Add a new sound
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Sounds
Body The details of the sounds PostSounds
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetSounds
400 Error
Tags
• Sounds
233
GET /sounds
GET /sounds
Description
Retrieve the list of sounds
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetSounds >
array
400 Error
limits
404 Not found Error
Tags
• Sounds
234
POST /sounds/upload
POST /sounds/upload
Description
Add a new sound
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Sound_uploa
PostSound_upload
Body ds The details of the sound_uploads
s
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetSound_uploads
400 Error
Tags
• Sounds
• Upload
235
GET /sounds/{guid}
GET /sounds/{guid}
Description
Retrieve the details about the sound with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSound
400 Error
limits
404 Not found Error
Tags
• Sounds
236
PUT /sounds/{guid}
PUT /sounds/{guid}
Description
Modify the values of the sound with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Sound
Body The new values of the sound PutSound
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetSound
400 Error
404 Not found Error
Tags
• Sounds
237
DELETE /sounds/{guid}
DELETE /sounds/{guid}
Description
Erase the sound with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Sounds
238
GET /sounds/{guid}/stream
GET /sounds/{guid}/stream
Description
Download the sound file of the sound with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSound_stream
400 Error
limits
404 Not found Error
Tags
• Sounds
• Stream
239
POST /ssl/cert
POST /ssl/cert
Description
Upload new certificate pair
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Cert
Body The details of the cert PostCert
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetCert
400 Error
Tags
• Cert
• Ssl
240
DELETE /ssl/cert
DELETE /ssl/cert
Description
Use default self-signed certificate
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Cert
• Ssl
241
GET /statistics/distance
GET /statistics/distance
Description
Retrieve the list with the distance driven by the robot at different dates and times
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
GetDistance_statist
ics
400 Error
limits
404 Not found Error
Tags
• Distance
• Statistics
242
GET /status
GET /status
Description
Retrieve the status
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetStatus
400 Error
limits
404 Not found Error
Tags
• Status
243
PUT /status
PUT /status
Description
Modify the status
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Status
Body The new values of the status PutStatus
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetStatus
400 Error
404 Not found Error
Tags
• Status
244
GET /system/info
GET /system/info
Description
Retrieve the information about the system. It contains different information like serial numbers of
hardware components, MAC addresses of network cards, etc…
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetSystem_info
400 Error
limits
404 Not found Error
Tags
• Info
• System
245
POST /user_groups
POST /user_groups
Description
Add a new user group
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
User_groups
Body The details of the user_groups PostUser_groups
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetUser_groups
400 Error
Tags
• User_groups
246
GET /user_groups
GET /user_groups
Description
Retrieve the list of user groups
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
< GetUser_groups
> array
400 Error
limits
404 Not found Error
Tags
• User_groups
247
GET /user_groups/{guid}
GET /user_groups/{guid}
Description
Retrieve the details about the user group with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetUser_group
400 Error
limits
404 Not found Error
Tags
• User_groups
248
PUT /user_groups/{guid}
PUT /user_groups/{guid}
Description
Modify the values of the user group with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
User_group
Body The new values of the user_group PutUser_group
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetUser_group
400 Error
404 Not found Error
Tags
• User_groups
249
DELETE /user_groups/{guid}
DELETE /user_groups/{guid}
Description
Erase the user group with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• User_groups
250
POST /user_groups/{user_group_guid}/permissions
POST /user_groups/{user_group_guid}/permissions
Description
Add a new permission to the group with the specified group GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
user_group_
The user_group_guid to add the new
Path guid string
resource to
required
User_group_
PostUser_group_p
Body permission The details of the user_group_permission
ermission
required
Responses
HTTP
Description Schema
Code
GetUser_group_pe
rmission
400 Error
Tags
• Permissions
• User_groups
251
GET /user_groups/{user_group_guid}/permissions
GET /user_groups/{user_group_guid}/permissions
Description
Retrieve the list of permissions of the user group with the specified group GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
user_group_
Path guid The user_group_guid to search for string
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetUser_group_pe
rmission > array
400 Error
limits
404 Not found Error
Tags
• Permissions
• User_groups
252
POST /users
POST /users
Description
Add a new user
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Users
Body The details of the users PostUsers
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetUsers
400 Error
Tags
• Users
253
GET /users
GET /users
Description
Retrieve the list of users
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved the list of elements < GetUsers > array
400 Error
limits
404 Not found Error
Tags
• Users
254
POST /users/auth
POST /users/auth
Description
Login with user credentials
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetUsers_auth
400 Error
Tags
• Auth
• Users
255
DELETE /users/auth
DELETE /users/auth
Description
Logout user
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Auth
• Users
256
GET /users/me
GET /users/me
Description
Retrieve the details about the user currently authorized in the API
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieved the list of elements < GetMe > array
400 Error
limits
404 Not found Error
Tags
• Me
• Users
257
PUT /users/me
PUT /users/me
Description
Modify the values of the user currently authorized in the API
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Me
Body The new values of the me PutMe
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetMe
400 Error
404 Not found Error
Tags
• Me
• Users
258
GET /users/me/permissions
GET /users/me/permissions
Description
Retrieve the permission of the user currently authorized in the API
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetUser_me_perm
issions > array
400 Error
limits
404 Not found Error
Tags
• Me
• Permissions
• Users
259
GET /users/{guid}
GET /users/{guid}
Description
Retrieve the details about the user with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetUser
400 Error
limits
404 Not found Error
Tags
• Users
260
PUT /users/{guid}
PUT /users/{guid}
Description
Modify the values of the user with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
User
Body The new values of the user PutUser
required
Responses
HTTP
Description Schema
Code
200 The element has been modified successfully GetUser
400 Error
404 Not found Error
Tags
• Users
261
DELETE /users/{guid}
DELETE /users/{guid}
Description
Erase the user with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Users
262
GET /wifi
GET /wifi
Description
Retrieve the URLs to the 3 WiFi related endpoints
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetWifi
400 Error
limits
404 Not found Error
Tags
• Wifi
263
POST /wifi/connections
POST /wifi/connections
Description
Add a new WiFi network configuration
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Wifi_connect
PostWifi_connecti
Body ions The details of the wifi_connections
ons
required
Responses
HTTP
Description Schema
Code
GetWifi_connectio
ns
400 Error
Tags
• Connections
• Wifi
264
GET /wifi/connections
GET /wifi/connections
Description
Retrieve the list of WiFi networks already configured
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetWifi_connectio
ns > array
400 Error
limits
404 Not found Error
Tags
• Connections
• Wifi
265
POST /wifi/connections/{uuid}
POST /wifi/connections/{uuid}
Description
Connect to the network with the specified UUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
uuid
Path The uuid to add the new resource to string
required
Wifi_connect
PostWifi_connecti
Body ion The details of the wifi_connection
on
required
Responses
HTTP
Description Schema
Code
GetWifi_connectio
n
400 Error
Tags
• Connections
• Wifi
266
GET /wifi/connections/{uuid}
GET /wifi/connections/{uuid}
Description
Retrieve the details about the WiFi network configuration with the specified UUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
uuid
Path The uuid to search for string
required
Responses
HTTP
Description Schema
Code
GetWifi_connectio
n
400 Error
limits
404 Not found Error
Tags
• Connections
• Wifi
267
DELETE /wifi/connections/{uuid}
DELETE /wifi/connections/{uuid}
Description
Erase the WiFi network configuration with the specified UUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
uuid
Path The uuid to delete string
required
Responses
HTTP
Description Schema
Code
400 Error
404 Not found Error
Tags
• Connections
• Wifi
268
GET /wifi/networks
GET /wifi/networks
Description
Retrieve the list of WiFi networks available for the robot to connect
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
<
200 Successfully retrieved the list of elements GetWifi_networks
> array
400 Error
limits
404 Not found Error
Tags
• Networks
• Wifi
269
GET /wifi/networks/{guid}
GET /wifi/networks/{guid}
Description
Retrieve the details about the WiFi network with the specified GUID
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
guid
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetWifi_network
400 Error
limits
404 Not found Error
Tags
• Networks
• Wifi
270
POST /world_model
POST /world_model
Description
Upload the world model with the existing robots, resources and positions and their respective locks
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
World_mode
Body l The details of the world_model PostWorld_model
required
Responses
HTTP
Description Schema
Code
201 The element has been created successfully GetWorld_model
400 Error
Tags
• World_model
271
GET /world_model
GET /world_model
Description
Retrieve the information about the needed resources from the robot
Parameters

DEFAULT_
Authorizatio
enum
(UI_API_KEY)
required
Responses
HTTP
Description Schema
Code
200 Successfully retrieve the specified element GetWorld_model
400 Error
limits
404 Not found Error
Tags
• World_model
272
Definitions
Error
Name Description Schema
error_code
The error in machine format string
optional
error_human
The error in human friendly format string
optional
GetAction_definition
Name Schema
action_type
string
optional
description
string
optional
descriptions
< object > array
optional
help
string
optional
mission_group_id
string
optional
name
string
optional
parameters
< object > array
optional
GetAction_definitions
Name Schema
action_type
string
optional
description
string
optional
descriptions
< object > array
optional
help
string
optional
mission_group_id
string
optional
273
Name Schema
name
string
optional
parameters
< object > array
optional
GetArea_action_definition
action_type
A name associated with this area action string
optional
action_type_id
The type of area action integer
optional
help
A description of this action string
optional
limit
The amount of actions of this type we can add. integer
optional
name
A nice name associated with this area action string
optional
parameters
string
optional
GetArea_action_definitions
action_type
A name associated with this area action string
optional
action_type_id
The type of area action integer
optional
help
A description of this action string
optional
limit
The amount of actions of this type we can add. integer
optional
name
optional
parameters
string
optional
GetArea_event
actions
object
optional
274
created_by
The url to the description of the type of this position string
optional
created_by_id
The global id of the user who created this entry string
optional
guid
The global id unique across robots that identifies this area string
optional
map
The url to the map this area belongs to string
optional
map_id
The id of the map this area belongs to string
optional
name
A name associated with this area string
optional
polygon
The list of coordinates in the area polygon < object > array
optional
type_id
The type of area integer
optional
GetArea_events
guid
optional
map
optional
name
optional
type_id
optional
url
The URL of the resource string
optional
GetArea_events_definitions
actions
string
optional
color
The color associated with this area string
optional
id
optional
image
string
optional
275
legacyName
string
optional
name
optional
GetBluetooth
address
The mac address of the blueooth device string
optional
name
The name of the bluetooth device string
optional
url
optional
GetBluetooth_relay
created_by
optional
created_by_id
optional
guid The global unique id across robots that identifies this
string
optional bluetooth device
hardware_id
The hardware id string for this bluetooth device string
optional
name
optional
type
Parameter to filter bluetooth devices string
optional
GetBluetooth_relays
string
optional bluetooth device
name
optional
type
Parameter to filter bluetooth devices string
optional
url
optional
276
GetBluetooth_status
Type : object
GetCart
cart_calibrati
on The url to the calibration of this cart string
optional
cart_calibrati
on_id The id of the calibration for this cart has string
optional
cart_type
The url to the type of this cart string
optional
cart_type_id
The id of the type of this cart string
optional
created_by
optional
created_by_id
optional
guid
The global id unique across robots that identifies this cart string
optional
name
The name of the cart string
optional
GetCart_calibration
created_by
optional
created_by_id
optional
drive_height The height of the hook when driving with carts of this cart
integer
optional calibration
entry_height
The entry height of the hook for the cart calibration integer
optional
guid The global id unique across robots that identifies this cart
string
lock_height
The lock height of the hook for the cart calibration integer
optional
name
The name of the cart calibration string
optional
277
qw
The qw quaternion of the cart calibration number (float)
optional
qx
The qx quaternion of the cart calibration number (float)
optional
qy
The qy quaternion of the cart calibration number (float)
optional
qz
The qz quaternion of the cart calibration number (float)
optional
standard
If the cart calibration is standard or not boolean
optional
x
The offset in the x-coordinate of the cart calibration number (float)
optional
y
The offset in the y-coordinate of the cart calibration number (float)
optional
z
The offset in the z-coordinate of the cart calibration number (float)
optional
GetCart_calibrations
string
name
The name of the cart calibration string
optional
url
optional
GetCart_type
created_by
optional
created_by_id
optional
string
optional type
height
The height of carts of this type number (float)
optional
length
The length of carts of this type number (float)
optional
name
The name of the cart type string
optional
278
offset_locked_
The offset from the center of the robot to the locked wheels
wheels number (float)
of carts of this type
optional
width
The width of carts of this type number (float)
optional
GetCart_types
string
optional type
name
The name of the cart type string
optional
url
optional
GetCarts
cart_calibrati
on The url to the calibration of this cart string
optional
cart_type
The url to the type of this cart string
optional
guid
The global id unique across robots that identifies this cart string
optional
name
The name of the cart string
optional
url
optional
GetCert
Type : object
GetDashboard
created_by
The url to the user that created the dashboard string
optional
created_by_id
optional
279
fleet_dashboa
rd boolean
optional
guid The global id unique across robots that identifies this
string
optional dashboard
name
The name of this dashboard string
optional
widgets The url to the possible widgets. if the dashboard does not
string
optional have any widgets then this field is empty
GetDashboard_widget
dashboard
The url to the dashboard where this widget belongs. string
optional
dashboard_id
The guid of the dashboard this widget belongs to string
optional
string
optional widget
settings
Widgets configuration encoded base 64 in json string
optional
GetDashboard_widgets
dashboard_id
The guid of the dashboard this widget belongs to string
optional
string
optional widget
url
optional
GetDashboards
string
optional dashboard
name
The name of this dashboard string
optional
url
optional
280
widgets The url to the possible widgets. if the dashboard does not
string
optional have any widgets then this field is empty
GetDistance_statistics
Name Schema
date
string (date-time)
optional
distance
number (float)
optional
GetDocking_offset
bar_distance
The width of the bars for bar_markers number (float)
optional
bar_length
The length of the bars for bar_markers number (float)
optional
created_by
optional
created_by_id
optional
docking_type
The docking type of the marker. integer
optional
string
optional docking offset
name The name of the docking offset. used for docking offset
string
optional independent from positions.
orientation_of
fset The orientation offset with respect to the docking marker number (float)
optional
pos_id The global id refering to the position that this offset belongs
string
optional to
position
The url to the position string
optional
shelf_leg_asy
The asymmetry of the shelf legs in the x direction with
mmetry_x number (float)
respect to the shelf legs marker
optional
x_offset
The x-offset with respect to the docking marker number (float)
optional
y_offset
The y-offset with respect to the docking marker number (float)
optional
281
GetDocking_offset_type
id The global id unique across robots that identifies this
integer
string
GetDocking_offset_types
id The global id unique across robots that identifies this
integer
string
url
optional
GetDocking_offsets
string
string
position
optional
url
optional
GetDocking_offsets_no_pos
string
string
position
optional
url
optional
282
GetElevator
active
Boolean indicating the state of the elevator boolean
optional
authenticatio
n Authentication type for the opcua server string
optional
created_by
The url to the description of this elevator string
optional
created_by_id
optional
driver
Driver used to connect to the elevator server string
optional
string
optional elevator
ip
The ip of the elevator string
optional
name
The name of the elevator string
optional
namespace Namespace under which the elevator is available on the
string
optional opcua server
one_way Integer indicating, if the elevator is one_way only, and in
integer
optional which direction
password
Password for the opcua server string
optional
port
Port on which the serer ir running integer
optional
security_polic
y Security policy type for the opcua server string
optional
session_guid
The global id unique across robots containing this elevator string
optional
turn_in_place
Boolean indicating if the robot can turn in the elevator boolean
optional
username
Username for the opcua server string
optional
GetElevator_cmd_check_server
Type : object
283
GetElevator_cmd_control
Type : object
GetElevator_cmd_door
Type : object
GetElevator_cmd_floor
Type : object
GetElevator_floor
created_by
The url to the description this elevator floor string
optional
created_by_id
optional
door The integer identifying the door used by the elevator on this
integer
optional floor
elevator_entry
_pos string
optional
elevator_entry
_pos_guid The id of the position located in front of the elevator string
optional
elevator_guid The global unique id of the elevator associated with this
string
optional floor
elevator_pos
string
optional
elevator_pos_
guid The id of the position located in the elevator string
optional
entry_mission
string
optional
entry_mission
_guid The id of the entry mission string
optional
exit_mission
string
optional
exit_mission_g
uid The id of the exit mission string
optional
284
floor
The integer identifying the floor integer
optional
string
optional elevator floor
map
string
optional
map_guid
The map id associated with the floor string
optional
session_guid
The global id unique across robots containing this elevator string
optional
GetElevator_floors
string
map
string
optional
map_guid
optional
url
optional
GetElevator_opcua_scanner
Type : object
GetElevator_status
name
optional
url
optional
GetElevators
string
optional elevator
name
optional
285
url
optional
GetError_report
description
string
optional
download_url
The url to where the bag can be downloaded string
optional
id
Id of the autobag integer
optional
module
The module that created the autolog string
optional
ready
Status of the rosbag boolean
optional
time
The time where the autolog was created string (date-time)
optional
GetError_report_download
Type : object
GetError_reports
description
string
optional
download_url
The url to where the bag can be downloaded string
optional
id
Id of the autobag integer
optional
module
The module that created the autolog string
optional
ready
Status of the rosbag boolean
optional
time
The time where the autolog was created string (date-time)
optional
GetFactory_reset
Type : object
286
GetFootprint
config_id The model name of the product for which the footprint is
string
optional created
created_by_id
optional
custom
Custom or rectangular footprint boolean
optional
footprint_poin
ts The string defining the points in xy of the footprint string
optional
string
optional type
height
The height of this footprint number (float)
optional
name
The name of the footprint type string
optional
GetFootprints
config_id The model name of the product for which the footprint is
string
optional created
string
optional type
name
The name of the footprint type string
optional
url
optional
GetGroup_action_definition
Name Schema
action_type
string
optional
description
string
optional
descriptions
< object > array
optional
help
string
optional
287
Name Schema
mission_group_id
string
optional
name
string
optional
parameters
< object > array
optional
GetGroup_missions
string
optional mission
name
The name of the mission string
optional
url
optional
GetHelper_positions
string
optional position
map
The url to the map this position belongs to string
optional
name
The name of the position string
optional
type_id
The type of position. see the general description above integer
optional
url
optional
GetHook
angle
The angle of the hook arm number (float)
optional
available
Whether the hook data is available or not boolean
optional
brake
brake
optional
gripper
gripper
optional
288
height
height
optional
brake

braked
Whether the hook brake is activated or not boolean
optional
state
The state of the hook brake in machine format integer
optional
state_string
The state of the hook brake in human format string
optional
gripper

closed
Whether the hook gripper is closed or not boolean
optional
state
The state of the hook gripper in machine format integer
optional
state_string
The state of the hook gripper in human format string
optional
height

height
The height of the hook in mm number (float)
optional
state
The state of the hook height control in machine format integer
optional
state_string
The state of the hook height control in human format string
optional
GetHook_brake
braked
Whether the brake of the hook is active or not boolean
optional
state
The state of the hook brake in machine format integer
optional
state_string
The state of the hook brake in human format string
optional
289
GetHook_gripper
closed
Whether the gripper of the hook is closed or not boolean
optional
state
The sate of the hook gripper in machine format integer
optional
state_string
The state of the hook gripper in human format string
optional
GetHook_height
height
The height of the hook in mm integer
optional
state
The state of the hook actuator in machine format integer
optional
state_string
The state of the hook actuator in human format string
optional
GetHw_config_export
Type : object
GetHw_config_import
Type : object
GetIo_module
address The address for connecting to the device. it can be a mac
string
optional address or an ip depending on the type of io module
created_by
The url to the description of the type of this io module string
optional
created_by_id
optional
guid The global unique id across robots that identifies this io
string
optional module
name
The name of the io module string
optional
num_inputs
The number of inputs that the io module has integer
optional
290
num_outputs
The number or outputs that the io module has integer
optional
type The type of the io module. currently supported devices
string
optional [bluetooth, wise].
GetIo_module_status
Type : object
GetIo_modules
guid The global unique id across robots that identifies this io
string
optional module
name
The name of the io module string
optional
type The type of the io module. currently supported devices
string
optional [bluetooth, wise].
url
optional
GetMap
created_by
optional
created_by_id
optional
guid
The global id unique across robots that identifies this map string
optional
map
If this map is navigation map or not string (byte)
optional
metadata
If this map is a web map or not string (byte)
optional
name
The name of the map string
optional
one_way_map
If this map is navigation map or not string (byte)
optional
origin_theta The angle in the map of the center of the map relative to the
number (float)
optional robots position
origin_x The x-coordinate in the map of the center of the map
number (float)
optional relative to the robots position
291
origin_y The y-coordinate in the map of the center of the map
number (float)
optional relative to the robots position
path_guides
The url to the list of path guides in this map string
optional
paths
The url to the list of paths in this map string
optional
positions
The url to the list of positions in this map string
optional
resolution
The resolution of the map number (float)
optional
session_id The global id unique across robots of the area containing
string
optional this map
GetMap_area_event
guid
optional
map
optional
name
optional
type_id
optional
url
optional
GetMap_path_guides
guid The global unique id across robots that identifies this path
string
optional guide
name
The name of the path guide string
optional
url
optional
GetMap_paths
goal_pos
The url to the end position of the path string
optional
292
guid
The global id unique across robots that identifies this path string
optional
start_pos
The url to the start position of the path string
optional
url
optional
GetMap_positions
string
optional position
map
optional
name
optional
type_id
optional
url
optional
GetMaps
guid
optional
name
optional
url
optional
GetMe
guid
The global unique id across robots that identifies this user string
optional
name
The name of the user string
optional
url
optional
user_group
Url for the user group this user is in string
optional
293
user_group_id
Global id of the user group this user is in string
optional
GetMission
actions
The url to the list of actions contained in this mission string
optional
created_by
optional
created_by_id
optional
definition
The url to the list of input parameters this mission accepts string
optional
description
The description of the mission string
optional
group_id The id of the area this mission belongs to, or null if the
string
optional mission belongs to all areas
string
optional mission
has_user_para
meters Indicates if the mission has dynamic parameters boolean
optional
hidden
If this mission is hidden in the mission list boolean
optional
is_template
True if the missions is a template mission boolean
optional
name
optional
session_id The id of the area this mission belongs to, or null if the
string
optional mission belongs to all areas
valid
Indicates if the mission contains only existing submissions boolean
optional
GetMission_action
action_type
The id of the type of action string
optional
string
optional mission
294
mission_id
The id of the mission the action belongs to string
optional
parameters
string
optional
priority
The priority of the action integer
optional
scope_referen
ce Reference to the scope in which the action belongs string
optional
GetMission_actions
action_type
The id of the type of action string
optional
string
optional mission
mission_id
The id of the mission the action belongs to string
optional
parameters
string
optional
priority
The priority of the action integer
optional
url
optional
GetMission_definition
action_type
string
optional
name
string
optional
url
optional
GetMission_group
created_by
optional
295
created_by_id
optional
feature
optional
string
optional position
icon
The name of the position string (byte)
optional
name
optional
priority
The name of the position integer
optional
GetMission_groups
string
optional position
name
optional
url
optional
GetMission_queue
actions
The list of parameters this mission queue entry accepts string
optional
control_posid
Global id of position used during control states string
optional
control_state Mission control state. a value above zero indicates that the
integer
optional robot needs an external input in order to continue
created_by
The url to the description of the type of this element string
optional
created_by_id
optional
description
Inerited from mission description, when item was queued string
optional
finished
The date and time when the mission was finished string (date-time)
optional
296
fleet_schedule
The guid of the mission scheduler element this mission
_guid string
queue element corresponds to on the fleet
optional
id
The id of the mission queue entry integer
optional
message
The last message produced by the actions in the mission list string
optional
mission
The url to the mission that mission that was executed string
optional
mission_id
The global id of the mission that was executed string
optional
ordered
The date end time when the mission was queued string (date-time)
optional
parameters
string
optional
priority
The id of the action integer
optional
started
The date and time when the missin was started string (date-time)
optional
state
The end state after the mission was executed string
optional
GetMission_queue_action
action_id
The id of the action string
optional
action_type
The name of the action string
optional
finished
The date and time when the action finished string (date-time)
optional
id
optional
message
The possible message produced by the action string
optional
mission_queu
e_id The id of the action integer
optional
parameters
The list of parameters to the action < object > array
optional
started
The date and time when the action was started string (date-time)
optional
297
state
The end state after executing the action string
optional
GetMission_queue_actions
action_id
The id of the action string
optional
action_type
The name of the action string
optional
finished
The date and time when the action finished string (date-time)
optional
id
optional
message
The possible message produced by the action string
optional
mission_queu
e_id The id of the action integer
optional
parameters
The list of parameters to the action < object > array
optional
started
The date and time when the action was started string (date-time)
optional
state
The end state after executing the action string
optional
GetMission_queues
id
The id of the mission queue entry integer
optional
state
The end state after the mission was executed string
optional
url
optional
GetMissions
string
optional mission
298
name
optional
url
optional
GetModbu
data_type
The data type needed string
optional
description
A more detailed explanation of the attribute string
optional
id
The id of the modbus entry integer
optional
permissions
If it is allowed to read or write this element string
optional
registers
The registers on the plc where the data will be stored < object > array
optional
title
A textual description of the desired element string
optional
type
The endpoint to which the element refers string
optional
GetModbus
data_type
The data type needed string
optional
description
optional
id
The id of the modbus entry integer
optional
permissions
If it is allowed to read or write this element string
optional
registers
The registers on the plc where the data will be stored < object > array
optional
title
A textual description of the desired element string
optional
type
The endpoint to which the element refers string
optional
299
GetModbus_mission
coil_id
The id of the coil to trigger the mission integer
optional
created_by The url to the description of the type of this modbus
string
optional mission
created_by_id
optional
string
optional modbus mission
id
The id of the modbus mission entry integer
optional
mission
The url to the mission details string
optional
mission_id
The global id of the mission that was executed string
optional
name
optional
parameters
string
optional
GetModbus_missions
coil_id
The id of the coil to trigger the mission integer
optional
string
optional modbus mission
url
optional
GetPath
autogenerated
If the path was autogenerated or not boolean
optional
footprint The footprint of the robot for which this path was
string
optional generated
goal_pos
optional
goal_pos_id
The id of the end position of the path string
optional
300
guid
optional
last_used
The date and time of the last time this path was used string (date-time)
optional
length
The length of the path in meters number (float)
optional
map_crc
The crc for the path string
optional
path
A binary representation of the path string (byte)
optional
start_pos
optional
start_pos_id
The id of the start position of the path string
optional
time
The time it took to drive the path the first time number (float)
optional
valid
If the path is valid or not boolean
optional
GetPath_guide
created_by
The url to the description of the type of this element string
optional
created_by_id
The global unique id of the user that created this path guide string
optional
goals_count
The number of goal positions in the path guide integer
optional
string
optional guide
map_id
The global id of the map this path guide belongs to string
optional
name
optional
options
The url to the list of position options for this path path string
optional
positions
The url to the list of positions used in this path guide string
optional
starts_count
The number of start positions in the path guide integer
optional
vias_count
The number of via positions in the path guide integer
optional
301
GetPath_guide_options
goals
The list of options for goal positions < goals > array
optional
starts
The list of options for start positions < starts > array
optional
vias
The list of options for via positions < vias > array
optional
goals

name
optional
pos_guid The global unique id across robots that identifies this
string
optional position
starts

name
optional
string
optional position
vias

name
optional
string
optional position
GetPath_guide_position
guid The global unique id across robots of the position in the list
string
optional of path constraints positions
path_guide_gu
The global unique id across robots of the path guide this
id string
position is related to
optional
string
optional position
302
pos_type
The type of position of the guide (start/via/goal) string
optional
priority The order in which to follow the via positions in the path
integer
optional guide
GetPath_guide_positions
string
path_guide_gu
id string
optional
pos_type
optional
url
optional
GetPath_guides
string
optional guide
name
optional
url
optional
GetPath_guides_position
string
path_guide_gu
id string
optional
string
optional position
pos_type
optional
priority The order in which to follow the via positions in the path
integer
optional guide
303
GetPath_guides_positions
string
path_guide_gu
id string
optional
pos_type
optional
url
optional
GetPath_guides_precalc
active Boolean indicating if a path guide precalculation is in
boolean
optional progress
fail_count
The number of paths that was not possible to precalculate integer
optional
message
Status message from the precalculation module string
optional
path_guide_gu
The global unique id across robots that identifies the path
id string
guide being precalculated
optional
success_count
The number of paths that has been successfully calculated integer
optional
total_count
The number of total paths to calculate integer
optional
GetPaths
goal_pos
optional
guid
optional
start_pos
optional
url
optional
304
GetPermission
endpoint
string
optional
string
optional permission
permission_ty
pe The permission type string
optional
user_group_gu
id The global id of the usergroup string
optional
GetPos_docking_offsets
string
string
position
optional
url
optional
GetPosition
created_by
optional
created_by_id
optional
docking_offset
The url to the possible docking offset. if the position does
s string
not have a docking offset then this field is empty
optional
string
optional position
help_positions
string
optional
map
optional
305
map_id
The global id of the map this positions belongs to string
optional
name
optional
orientation The orientation of the position in degrees relative to origo
number (float)
optional of the underlying map
parent The url to the possible parent position. if the position does
string
optional not have a parent position then this field is empty
The global id of the possible parent position of the current
position. a parent position is a position related to the
parent_id current position, for instance the parent position of a
string
optional trolley left entry position is the actual trolley position. if the
position does not have a parent position then this field is
empty
pos_x The x-coordinate of the position relative to origo of the
number (float)
optional underlying map
pos_y The y-coordinate of the position relative to origo of the
number (float)
optional underlying map
type
optional
type_id
optional
GetPosition_transition_list
created_by
optional
created_by_id
optional
goal_pos_id
The id of the end position for the transition list string
optional
guid
optional
mission_id
The guid of the mission in the transition list string
optional
start_pos_id
The id of the start position for the transition list string
optional
GetPosition_transition_list_from_session
306
created_by
optional
created_by_id
optional
goal_pos_id
optional
guid
optional
mission_id
optional
start_pos_id
optional
GetPosition_transition_lists
created_by
optional
created_by_id
optional
goal_pos_id
optional
guid
optional
mission_id
optional
start_pos_id
optional
GetPosition_type
hidden
False if the position is not created by the user boolean
optional
id
Unique id for the position type integer
optional
name
Name of the position type string
optional
reachable_for
_robot True if the robot can actually go to that position boolean
optional
307
GetPosition_types
id
Unique id for the position type integer
optional
name
Name of the position type string
optional
url
optional
GetPositions
string
optional position
map
optional
name
optional
type_id
optional
url
optional
GetRegister
id
The index of the register integer
optional
label
A label for the register string
optional
value
The value of the register number (float)
optional
GetRegisters
id
The index of the register integer
optional
label
A label for the register string
optional
url
optional
308
value
The value of the register number (float)
optional
GetRemote_support
Type : object
GetRemote_support_log
Type : object
GetRobots
Type : object
GetService_book
created_at
Creation time of the service note string
optional
created_by
The url to the user string
optional
created_by_id
The user which created the log string
optional
created_by_na
me The user name which created the log string
optional
description
The sevice note string
optional
string
optional service note
owner_group
The url to the owner group string
optional
owner_group_
guid The usergroup which owns the service book string
optional
owner_group_
name The group name which owns the log string
optional
GetService_books
309
created_at
Creation time of the service note string
optional
created_by
The url to the user string
optional
created_by_id
The user which created the log string
optional
created_by_na
me The user name which created the log string
optional
description
The sevice note string
optional
string
optional service note
owner_group
The url to the owner group string
optional
owner_group_
guid The usergroup which owns the service book string
optional
owner_group_
name The group name which owns the log string
optional
GetSession
active Boolean indicating whether the session is the active session
boolean
optional in the fleet
created_by
optional
created_by_id
optional
description
A possible description of the area string
optional
export
string
optional
guid
optional
maps
The url to the list of maps that is in this area string
optional
name
The name of the area string
optional
310
GetSession_elevator_floors
string
map
string
optional
map_guid
optional
url
optional
GetSession_elevators
string
optional elevator
name
optional
url
optional
GetSession_export
Type : object
GetSession_import
error_messag
e A description of this action string
optional
sessions_impo
rted The type of area action integer
optional
sessions_total
A name associated with this area action integer
optional
status
A nice name associated with this area action integer
optional
GetSession_maps
311
guid
optional
name
optional
url
optional
GetSession_missions
string
optional mission
name
optional
url
optional
GetSessions
guid
optional
name
The name of the area string
optional
url
optional
GetSetting
Name Schema
children_ids
string
optional
constraints
string
optional
default
string
optional
description
string
optional
editable
string
optional
fieldtype
string
optional
312
Name Schema
full_name
string
optional
id
integer
optional
name
string
optional
parent_id
string
optional
parent_name
string
optional
parent_value
string
optional
settings_group
string
optional
settings_group_id
integer
optional
type
string
optional
value
string
optional
GetSetting_advanced
Name Schema
children_ids
string
optional
constraints
string
optional
default
string
optional
description
string
optional
editable
string
optional
fieldtype
string
optional
full_name
string
optional
id
integer
optional
name
string
optional
313
Name Schema
parent_id
string
optional
parent_name
string
optional
parent_value
string
optional
settings_group
string
optional
settings_group_id
integer
optional
type
string
optional
value
string
optional
GetSetting_group
Name Schema
advanced_settings_count
integer
optional
description
string
optional
id
integer
optional
name
string
optional
priority
integer
optional
settings_count
integer
optional
GetSetting_group_advanced_settings
default
string
optional
id
integer
optional
name
string
optional
parent_name
string
optional
314
url
optional
value
string
optional
GetSetting_group_settings
default
string
optional
id
integer
optional
name
string
optional
parent_name
string
optional
url
optional
value
string
optional
GetSetting_groups
id
integer
optional
name
string
optional
url
optional
GetSettings
default
string
optional
id
integer
optional
name
string
optional
parent_name
string
optional
315
url
optional
value
string
optional
GetSettings_advanced
default
string
optional
id
integer
optional
name
string
optional
parent_name
string
optional
url
optional
value
string
optional
GetSoftware_backup
date
The date where the backup was created string (date-time)
optional
guid
The guid of the software backup string
optional
state
The state of the software backup string
optional
version
The version of the software backup string
optional
GetSoftware_backups
date
The date where the backup was created string (date-time)
optional
guid
The guid of the software backup string
optional
state
The state of the software backup string
optional
316
url
optional
version
The version of the software backup string
optional
GetSoftware_log
action
The action performed (upgrade/restore) string
optional
end_time
The end time of the upgrade string (date-time)
optional
from
The software version upgrading from string
optional
guid
The guid of upgrade entry string
optional
message
The status message from upgrade string
optional
start_time
The start time of the upgrade string (date-time)
optional
state
The state of the upgrade (succeeded/failed/started string
optional
to
The software version upgrading to string
optional
GetSoftware_logs
action
The action performed (upgrade/restore) string
optional
end_time
The end time of the upgrade string (date-time)
optional
from
The software version upgrading from string
optional
guid
The guid of upgrade entry string
optional
start_time
The start time of the upgrade string (date-time)
optional
state
The state of the upgrade (succeeded/failed/started string
optional
to
The software version upgrading to string
optional
317
url
optional
GetSoftware_upgrade
guid
The guid of the software upgrade string
optional
upload_date
The upload date of the software upgrade string (date-time)
optional
version
The version of the software upgrade string
optional
GetSoftware_upgrades
guid
The guid of the software upgrade string
optional
upload_date
The upload date of the software upgrade string (date-time)
optional
url
optional
version
The version of the software upgrade string
optional
GetSound
created_by
optional
created_by_id
optional
guid
The global id unique across robots that identifies this sound string
optional
length
The length of the sound in the format hh:mm:ss string
optional
name
The name of the sound string
optional
note
A possible description of the sound string
optional
sound
A binary representation of the sound string (byte)
optional
318
stream
The url to stream the raw audio string
optional
volume
The volumne of the sound when played integer
optional
GetSound_stream
Type : object
GetSound_uploads
Type : object
GetSounds
guid
The global id unique across robots that identifies this sound string
optional
length
The length of the sound in the format hh:mm:ss string
optional
name
The name of the sound string
optional
url
optional
volume
The volumne of the sound when played integer
optional
GetStatus
battery_perce
ntage The current charge percentage of the battery number (float)
optional
battery_time_
The approximate time remaining on the battery during
remaining integer
normal operation of the robot
optional
distance_to_ne
xt_target The distance to the next target of the robot number (float)
optional
errors
The list of actions executed as part of the mission < errors > array
optional
319
footprint
The current footprint of the robot string
optional
hook_data
hook_data
optional
hook_status
hook_status
optional
joystick_low_s
peed_mode_en
boolean
abled
optional
joystick_web_s
ession_id The id of the web user that has control over the joystick string
optional
map_id
The id of the current map the robot recides in string
optional
mission_queu
e_id The id of the current job the robot executes integer
optional
mission_queu
e_url The url to the active mission in queue string
optional
mission_text
Status message from mission controller string
optional
mode_id
The id of the current mode of the robot integer
optional
mode_key_stat
e A textual description of the position of the mode key string
optional
mode_text
A textual description of the current state of the robot string
optional
moved
number (float)
optional
position
position
optional
robot_model
The model of the robot string
optional
robot_name
The name of the robot string
optional
safety_system
_muted boolean
optional
serial_number
The model of the robot string
optional
320
session_id
The id of the session the robot recides in string
optional
state_id
The id of the current state of the robot integer
optional
state_text
A textual description of the current state of the robot string
optional
unloaded_ma
p_changes boolean
optional
uptime
The uptime of the robot integer
optional
user_prompt
user_prompt
optional
velocity
velocity
optional
errors

code
The error code integer
optional
description
Description of the error string
optional
module
The module reporting the error string
optional
hook_data

angle
angle
optional
height
Height of the hook measured from the ground in mm. number (float)
optional
length
Length of the hook in meters. number (float)
optional
angle

angle
Angle of the hook in degrees. number (float)
optional
hook_status
321
available
Boolean indicating if the hook available on this robot boolean
optional
cart
cart
optional
cart_attached
Boolean indicating if a trolley is currently attached boolean
optional
cart

height
The height of the attached trolley number (float)
optional
id
The id of the attached trolley number (float)
optional
length
The length of the attached trolley number (float)
optional
offset_locked_
The distance from front of the attached trolley to the locked
wheels
optional
width
The width of the attached trolley number (float)
optional
position

orientation
The orientation of the current position of the robot number (float)
optional
x
The x-coordinate of the current position of the robot number (float)
optional
y
The y-coordinate of the current position of the robot number (float)
optional
user_prompt
Name Schema
guid
string
optional
options
< string > array
optional
question
string
optional
timeout
number (float)
optional
322
Name Schema
user_group
string
optional
velocity

angular
The angular speed of the robot in degrees/s number (float)
optional
linear
The linear speed of the robot in m/s number (float)
optional
GetSystem_info
Type : object
GetUser
create_time
Creation time of the user string
optional
created_by
optional
created_by_id
optional
dashboard_id
string
optional
email
The email of the user string
optional
guid
optional
name
optional
single_dashbo
ard boolean
optional
update_time
Last time the user was updated string
optional
url
Url to this user string
optional
user_group
optional
user_group_id
optional
323
username
The username of the user string
optional
GetUser_group
create_time
Creation time of the usergroup string
optional
created_by
optional
created_by_id
optional
string
optional usergroup
name
Name of the usergroup string
optional
update_time
Last time the usergroup was updated string
optional
GetUser_group_permission
endpoint
string
optional
string
optional permission
permission_ty
optional
url
optional
GetUser_groups
string
optional usergroup
name
Name of the usergroup string
optional
url
optional
324
GetUser_me_permissions
endpoint
string
optional
string
optional permission
permission_ty
optional
url
optional
GetUsers
guid
optional
name
optional
url
optional
user_group
optional
user_group_id
optional
GetUsers_auth
Name Schema
expiration_time
string (date-time)
optional
ip
string
optional
login_time
string (date-time)
optional
token
string
optional
user_id
string
optional
325
GetWifi
Type : object
GetWifi_connection
bssid
Access point mac address string
optional
connected
Connected to the network of this connection boolean
optional
device
Device to use for this connection string
optional
dns
Dnss for the connection string
optional
ip_address
Ip address for the connection string
optional
last_connecte
Date and time for when the connection was last
d string
successfully connected
optional
mac
Network adapter mac address string
optional
name
Name or id of the connection string
optional
netmask
Netmask for the connection string
optional
security
The security method used by the connection string
optional
type
Connection type e.g. 802-11-wireless string
optional
url
Specific connection string
optional
uuid
Uuid of the connection string
optional
GetWifi_connections
bssid
Access point mac address string
optional
connected
Connected to the network of this connection boolean
optional
326
mac
Network adapter mac address string
optional
name
Name or id of the connection string
optional
url
optional
uuid
Uuid of the connection string
optional
GetWifi_network
channel
Network channel integer
optional
connected
Connected to this network boolean
optional
device
Device string
optional
frequency
Network frequency string
optional
guid
The guid of the wifi string
optional
security
Security string
optional
ssid
Ssid of the wlan string
optional
strength
Signal strength integer
optional
url
Specific wifi network string
optional
GetWifi_networks
connected
Connected to this network boolean
optional
guid
The guid of the wifi string
optional
ssid
Ssid of the wlan string
optional
url
optional
327
GetWorld_model
Type : object
PostAction_definition
Name Schema
parameters
< object > array
required
PostArea_events
actions
< object > array
optional
created_by_id
string
optional
guid
string
optional
map_id
string
required
name
Max length: 255 string
optional
polygon
< object > array
required
type_id
integer (float)
required
PostBluetooth_relays
created_by_id
string
optional
guid
string
optional
hardware_id
string
required
name
Min length: 1, Max length: 255 string
required
PostBluetooth_status
328
Name Schema
module_guid
string
required
PostCart_calibrations
created_by_id
string
optional
drive_height
integer (float)
required
entry_height
integer (float)
required
guid
string
optional
lock_height
integer (float)
required
name
required
qw
number (float)
required
qx
number (float)
required
qy
number (float)
required
qz
number (float)
required
standard
boolean
required
x
number (float)
required
y
number (float)
required
z
number (float)
required
PostCart_types
created_by_id
string
optional
guid
string
optional
329
height
number (float)
required
length
number (float)
required
name
required
offset_locked_
required
width
number (float)
required
PostCarts
cart_calibrati
on_id string
required
cart_type_id
string
required
created_by_id
string
optional
guid
string
optional
name
required
PostCert
Name Schema
cert_key_file
string (byte)
required
cert_pem_file
string (byte)
required
PostDashboard_widgets
Name Schema
dashboard_id
string
required
guid
string
optional
330
Name Schema
settings
string
optional
PostDashboards
created_by_id
string
optional
fleet_dashboa
rd boolean
optional
guid
string
optional
name
required
PostDocking_offsets
created_by_id
string
optional
docking_type
integer (float)
optional
guid
string
optional
name
required
orientation_of
fset number (float)
required
pos_id
string
optional
x_offset
number (float)
required
y_offset
number (float)
required
PostElevator_cmd_control
Name Schema
request
boolean
required
331
PostElevator_cmd_door
Name Schema
door_front
boolean
required
door_rear
boolean
required
open
boolean
required
PostElevator_cmd_floor
Name Schema
door_front
boolean
required
door_rear
boolean
required
floor
integer (float)
required
PostElevator_floors
Name Schema
created_by_id
string
optional
door
integer (float)
required
elevator_entry_pos_guid
string
required
elevator_guid
string
required
elevator_pos_guid
string
required
entry_mission_guid
string
optional
exit_mission_guid
string
optional
floor
integer (float)
required
guid
string
optional
map_guid
string
required
332
PostElevators
Name Schema
active
boolean
optional
authentication
string
optional
created_by_id
string
optional
driver
string
required
guid
string
optional
ip
string
required
name
string
required
namespace
string
optional
one_way
integer (float)
optional
password
string
optional
port
integer (float)
optional
security_policy
string
optional
session_guid
string
required
turn_in_place
boolean
optional
username
string
optional
PostError_reports
description
required
PostFactory_reset
333
Name Schema
file
string
optional
PostFootprints
config_id
string
required
created_by_id
string
optional
footprint_poin
ts string
required
guid
string
optional
height
number (float)
required
name
required
PostHw_config_import
Name Schema
file
string
required
PostIo_module_status
Type : object
PostIo_modules
address
string
required
created_by_id
string
optional
guid
string
optional
name
required
334
num_inputs
integer (float)
optional
num_outputs
integer (float)
optional
type
string
optional
PostMaps
created_by_id
string
optional
guid
string
optional
map
string (byte)
required
metadata
string (byte)
required
name
required
one_way_map
string (byte)
optional
origin_theta
number (float)
required
origin_x
number (float)
required
origin_y
number (float)
required
resolution
number (float)
required
session_id
string
required
PostMission_actions
action_type
required
guid
string
optional
mission_id
string
required
335
parameters
< object > array
required
priority
integer (float)
required
scope_referen
ce string
optional
PostMission_groups
created_by_id
string
optional
feature
required
guid
string
optional
icon
string (byte)
required
name
required
priority
integer (float)
required
PostMission_queues
fleet_schedule
_guid Max length: 36 string
optional
message
optional
mission_id
string
required
parameters
< object > array
optional
priority
integer (float)
optional
PostMissions
336
created_by_id
string
optional
description
optional
group_id
string
required
guid
string
optional
hidden
boolean
optional
name
required
session_id
string
optional
PostModbus_missions
coil_id
integer (float)
required
created_by_id
string
optional
guid
string
optional
mission_id
string
required
name
required
parameters
< object > array
optional
PostPath_guide_positions
Name Schema
guid
string
optional
path_guide_guid
string
required
pos_guid
string
required
pos_type
string
required
337
Name Schema
priority
integer (float)
optional
PostPath_guides
created_by_id
string
optional
guid
string
optional
map_id
string
required
name
required
PostPath_guides_positions
Name Schema
guid
string
optional
path_guide_guid
string
required
pos_guid
string
required
pos_type
string
required
priority
integer (float)
optional
PostPath_guides_precalc
Name Schema
command
string
required
guid
string
required
PostPaths
338
autogenerated
boolean
required
footprint
required
goal_pos_id
string
required
guid
string
optional
last_used
string (date-time)
required
length
number (float)
required
map_crc
required
path
string (byte)
required
start_pos_id
string
required
time
number (float)
required
valid
boolean
required
PostPosition_transition_lists
Name Schema
created_by_id
string
optional
goal_pos_id
string
required
guid
string
optional
mission_id
string
required
start_pos_id
string
required
PostPositions
created_by_id
string
optional
339
guid
string
optional
map_id
string
required
name
required
orientation
number (float)
required
parent_id
string
optional
pos_x
number (float)
required
pos_y
number (float)
required
type_id
integer (float)
required
PostRegister
label
optional
value
number (float)
optional
PostRobots
Name Schema
robots
< object > array
required
PostService_books
description
required
guid
string
optional
PostSession_import
340
Name Schema
file
string
required
PostSessions
created_by_id
string
optional
description
optional
guid
string
optional
name
required
PostSound_uploads
Name Schema
file
string
required
PostSounds
created_by_id
string
optional
guid
string
optional
name
required
note
optional
sound
string (binary)
required
volume
integer (float)
optional
PostUser_group_permission
341
endpoint
required
guid
string
optional
permission_ty
pe string
required
PostUser_groups
created_by_id
string
optional
guid
string
optional
name
required
PostUsers
created_by_id
string
optional
dashboard_id
string
optional
email
string
optional
guid
string
optional
name
required
password
string
required
pincode
string
optional
single_dashbo
ard boolean
optional
user_group_id
string
required
username
required
342
PostWifi_connection
Name Schema
address
string
optional
device
string
optional
dns
string
optional
gateway
string
optional
netmask
string
optional
security
string
optional
ssid
string
required
PostWifi_connections
Name Schema
address
string
optional
device
string
optional
dns
string
optional
gateway
string
optional
netmask
string
optional
security
string
optional
ssid
string
required
PostWorld_model
Name Schema
robot_ip
string
optional
world_model
< object > array
optional
343
PutArea_event
actions
< object > array
optional
name
optional
polygon
< object > array
optional
PutBluetooth_relay
hardware_id
string
optional
name
optional
PutBluetooth_status
Name Schema
on
boolean
optional
port
integer (float)
optional
timeout
integer (float)
optional
PutCart
cart_calibrati
on_id string
optional
cart_type_id
string
optional
name
optional
PutCart_calibration
344
drive_height
integer (float)
optional
entry_height
integer (float)
optional
lock_height
integer (float)
optional
name
optional
qw
number (float)
optional
qx
number (float)
optional
qy
number (float)
optional
qz
number (float)
optional
standard
boolean
optional
x
number (float)
optional
y
number (float)
optional
z
number (float)
optional
PutCart_type
height
number (float)
optional
length
number (float)
optional
name
optional
offset_locked_
optional
width
number (float)
optional
345
PutDashboard
name
optional
PutDashboard_widget
Name Schema
settings
string
optional
PutDocking_offset
name
optional
orientation_of
fset number (float)
optional
x_offset
number (float)
optional
y_offset
number (float)
optional
PutElevator
active
boolean
optional
authenticatio
n Choices are: {"Anonymous", "Username", "Certificate"} string
optional
ip
string
optional
name
string
optional
namespace
string
optional
one_way
integer (float)
optional
password
string
optional
346
port
integer (float)
optional
session_guid
string
optional
turn_in_place
boolean
optional
username
string
optional
PutElevator_floor
Name Schema
door
integer (float)
optional
elevator_entry_pos_guid
string
optional
elevator_guid
string
optional
elevator_pos_guid
string
optional
entry_mission_guid
string
optional
exit_mission_guid
string
optional
floor
integer (float)
optional
map_guid
string
optional
PutFootprint
config_id Choices are: {"MIR500-1000", "MIR100-200", "MIR250",
string
optional "HOOK", "UNKNOWN"}
footprint_poin
ts string
optional
height
number (float)
optional
name
optional
347
PutHook_brake
state
Choices are: {0, 1} integer (float)
optional
PutHook_gripper
state
optional
PutHook_height
Name Schema
height
integer (float)
optional
home
boolean
optional
PutIo_module
address
string
optional
name
optional
num_inputs
integer (float)
optional
num_outputs
integer (float)
optional
type
Choices are: {"bluetooth", "wise"} string
optional
PutIo_module_status
Name Schema
on
boolean
optional
port
integer (float)
optional
348
Name Schema
timeout
integer (float)
optional
PutMap
map
string (byte)
optional
metadata
string (byte)
optional
name
optional
one_way_map
string (byte)
optional
origin_theta
number (float)
optional
origin_x
number (float)
optional
origin_y
number (float)
optional
resolution
number (float)
optional
PutMe
dashboard_id
string
optional
email
string
optional
name
optional
password
string
optional
pincode
string
optional
single_dashbo
ard boolean
optional
user_group_id
string
optional
349
username
optional
PutMission
description
optional
group_id
string
optional
hidden
boolean
optional
name
optional
session_id
string
optional
PutMission_action
Name Schema
parameters
< object > array
optional
priority
integer (float)
optional
scope_reference
string
optional
PutMission_group
feature
optional
icon
string (byte)
optional
name
optional
priority
integer (float)
optional
PutMission_queue
350
cmd
integer (float)
optional
description
optional
mission_id
string
optional
priority
integer (float)
optional
PutModbus_mission
coil_id
integer (float)
optional
mission_id
string
optional
name
optional
parameters
< object > array
optional
PutPath
autogenerated
boolean
optional
footprint
optional
goal_pos_id
string
optional
last_used
string (date-time)
optional
length
number (float)
optional
map_crc
optional
path
string (byte)
optional
start_pos_id
string
optional
time
number (float)
optional
351
valid
boolean
optional
PutPath_guide
map_id
string
optional
name
optional
PutPath_guide_position
Name Schema
pos_guid
string
optional
priority
integer (float)
optional
PutPath_guides_position
Name Schema
pos_guid
string
optional
priority
integer (float)
optional
PutPosition
map_id
string
optional
name
optional
orientation
number (float)
optional
parent_id
string
optional
pos_x
number (float)
optional
352
pos_y
number (float)
optional
type_id
integer (float)
optional
PutPosition_transition_list
Name Schema
goal_pos_id
string
optional
mission_id
string
optional
start_pos_id
string
optional
PutRemote_support
Name Schema
connection_countdown
number (float)
optional
PutSession
active
boolean
optional
description
optional
name
optional
PutSetting
value
optional
PutSetting_advanced
353
value
optional
PutSound
name
optional
note
optional
sound
string (binary)
optional
volume
integer (float)
optional
PutStatus
answer
optional
clear_error
boolean
optional
datetime
string (date-time)
optional
guid
string
optional
map_id
string
optional
mode_id
optional
name
optional
position
object
optional
serial_number
string
optional
state_id
Choices are: {3, 4, 11}, State: {Ready, Pause, Manualcontrol} integer (float)
optional
web_session_i
d string
optional
354
PutUser
dashboard_id
string
optional
email
string
optional
name
optional
password
string
optional
pincode
string
optional
single_dashbo
ard boolean
optional
user_group_id
string
optional
username
optional
PutUser_group
name
optional
355

Mir250 Rest API 2.10.0

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Mir250 Rest API 2.10.0

Uploaded by

Copyright:

Available Formats

2.10.

0 MIR250 REST API

An example header would look like this:

SHA-256 encoder http://www.xorbin.com/tools/sha256-hash-calculator

Base64 encoded https://www.base64encode.org/

Retrieve the list of action definitions

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Add a new action definition with the specified action_type

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Add a new area event

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Retrieve the list of area events

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Retrieve definitions of area actions and their parameters

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Retrieve definitions of areas and their actions

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Erase the area event with the specified GUID

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Connect to the Bluetooth device with the given GUID

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Retrieve the status of the Bluetooth connection

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Modify the outputs of the connected Bluetooth device

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Disconnect the Bluetooth device

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Retrieve the list of discovered devices

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Start the discovery of Bluetooth devices

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Add a new Bluetooth device

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Retrieve the list of configured Bluetooth devices

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Type Name Description Schema Default

Accept- enum (en_US, "UI_API_

Erase the Bluetooth device with the specified GUID

Type Name Description Schema Default