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 ...
2.5.0 MIR200 REST API
Overview
The REST API for the 2.5.0 interface of MIR200
Version information
Version : 2.5.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 Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetAction_definiti ons
Error
Error
Tags
· Actions
3
POST /actions/{action_type}
POST /actions/{action_type}
Description
Add a new action definition with the specified action_type
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
action_type required
The action_type to add the new resource to
Action_definit
ion
The details of the action_definition
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PostAction_definitio n
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetAction_definiti on Error 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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
action_type required
The action_type to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetAction_definiti on
Error
Error
Tags
· Actions
5
POST /area_events
POST /area_events
Description
Add a new area event
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Area_events required
The details of the area_events
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostArea_events
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetArea_events Error Error
Tags
· Area_events
6
GET /area_events
GET /area_events
Description
Retrieve the list of area events
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetArea_events > array
Error
Error
Tags
· Area_events
7
GET /area_events/{guid}
GET /area_events/{guid}
Description
Retrieve the details about the area event with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetArea_event Error Error
Tags
· Area_events
8
PUT /area_events/{guid}
PUT /area_events/{guid}
Description
Modify the values of the area event with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Area_event required
The new values of the area_event
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutArea_event
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetArea_event
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Area_events
9
DELETE /area_events/{guid}
DELETE /area_events/{guid}
Description
Erase the area event with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Area_events
10
POST /bluetooth
POST /bluetooth
Description
Connect to the Bluetooth device with the given GUID
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Bluetooth_stat
us
The details of the bluetooth_status
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostBluetooth_status
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetBluetooth_stat us Error Error
Tags
· Bluetooth
11
GET /bluetooth
GET /bluetooth
Description
Retrieve the status of the Bluetooth connection
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetBluetooth_stat us
Error
Error
Tags
· Bluetooth
12
PUT /bluetooth
PUT /bluetooth
Description
Modify the outputs of the connected Bluetooth device
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Bluetooth_stat
us
The new values of the bluetooth_status
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PutBluetooth_status
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetBluetooth_stat us
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Bluetooth
13
DELETE /bluetooth
DELETE /bluetooth
Description
Disconnect the Bluetooth device
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Bluetooth
14
POST /bluetooth/scan
POST /bluetooth/scan
Description
Retrieve the list of discovered devices
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetBluetooth Error Error
Tags
· Bluetooth · Scan
15
GET /bluetooth/scan
GET /bluetooth/scan
Description
Start the discovery of Bluetooth devices
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetBluetooth > array
Error
Error
Tags
· Bluetooth · Scan
16
POST /bluetooth_relays
POST /bluetooth_relays
Description
Add a new Bluetooth device
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Bluetooth_rel
ays
The details of the bluetooth_relays
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostBluetooth_relays
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetBluetooth_rela ys Error Error
Tags
· Bluetooth_relays
17
GET /bluetooth_relays
GET /bluetooth_relays
Description
Retrieve the list of configured Bluetooth devices
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetBluetooth_rela ys > array
Error
Error
Tags
· Bluetooth_relays
18
GET /bluetooth_relays/{guid}
GET /bluetooth_relays/{guid}
Description
Retrieve the details about the Bluetooth device with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetBluetooth_rela y
Error
Error
Tags
· Bluetooth_relays
19
PUT /bluetooth_relays/{guid}
PUT /bluetooth_relays/{guid}
Description
Modify the values of the Bluetooth device with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Bluetooth_rel
ay
The new values of the bluetooth_relay
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
PutBluetooth_relay
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetBluetooth_rela y
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Bluetooth_relays
20
DELETE /bluetooth_relays/{guid}
DELETE /bluetooth_relays/{guid}
Description
Erase the Bluetooth device with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Bluetooth_relays
21
POST /cart_calibrations
POST /cart_calibrations
Description
Add a new cart calibration
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Cart_calibrati
ons
The details of the cart_calibrations
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostCart_calibration s
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetCart_calibratio ns Error Error
Tags
· Cart_calibrations
22
GET /cart_calibrations
GET /cart_calibrations
Description
Retrieve the list of cart calibrations
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetCart_calibratio ns > array
Error
Error
Tags
· Cart_calibrations
23
GET /cart_calibrations/{guid}
GET /cart_calibrations/{guid}
Description
Retrieve the details about the cart calibration with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetCart_calibratio n
Error
Error
Tags
· Cart_calibrations
24
PUT /cart_calibrations/{guid}
PUT /cart_calibrations/{guid}
Description
Modify the values of the cart calibration with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Cart_calibrati
on
The new values of the cart_calibration
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
PutCart_calibration
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetCart_calibratio n
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Cart_calibrations
25
DELETE /cart_calibrations/{guid}
DELETE /cart_calibrations/{guid}
Description
Erase the cart calibration with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Cart_calibrations
26
POST /cart_types
POST /cart_types
Description
Add a new cart type
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Cart_types required
The details of the cart_types
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostCart_types
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetCart_types Error Error
Tags
· Cart_types
27
GET /cart_types
GET /cart_types
Description
Retrieve the list of cart types
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetCart_types > array
Error
Error
Tags
· Cart_types
28
GET /cart_types/{guid}
GET /cart_types/{guid}
Description
Retrieve the details about the cart type with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetCart_type Error Error
Tags
· Cart_types
29
PUT /cart_types/{guid}
PUT /cart_types/{guid}
Description
Modify the values of the cart type with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Cart_type required
The new values of the cart_type
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutCart_type
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetCart_type
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Cart_types
30
DELETE /cart_types/{guid}
DELETE /cart_types/{guid}
Description
Erase the cart type with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Cart_types
31
POST /carts
POST /carts
Description
Add a new cart
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Carts required
The details of the carts
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostCarts
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetCarts Error Error
Tags
· Carts
32
GET /carts
GET /carts
Description
Retrieve the list of carts
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
< GetCarts > array Error Error
Tags
· Carts
33
GET /carts/{guid}
GET /carts/{guid}
Description
Retrieve the details about the cart with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetCart Error Error
Tags
· Carts
34
PUT /carts/{guid}
PUT /carts/{guid}
Description
Modify the values of the cart with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Cart required
The new values of the cart
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutCart
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetCart
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Carts
35
DELETE /carts/{guid}
DELETE /carts/{guid}
Description
Erase the cart with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Carts
36
GET /changes/me
GET /changes/me
Description
Makes a list of all data owned by the current user or users with lower authority
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetChanges_me Error Error
Tags
· Changes · Me
37
DELETE /changes/me
DELETE /changes/me
Description
Deletes all data owned by the current user or users with lower authority
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Changes · Me
38
POST /dashboards
POST /dashboards
Description
Add a new dashboard
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Dashboards required
The details of the dashboards
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostDashboards
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetDashboards Error Error
Tags
· Dashboards
39
GET /dashboards
GET /dashboards
Description
Retrieve the list of dashboards
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetDashboards > array
Error
Error
Tags
· Dashboards
40
POST /dashboards/{dashboard_id}/widgets
POST /dashboards/{dashboard_id}/widgets
Description
Add a new widget to the dashboard with the specified dashboard ID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
dashboard_id required
The dashboard_id to add the new resource to
Dashboard_wi
dgets
The details of the dashboard_widgets
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PostDashboard_widg ets
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetDashboard_wi dgets Error Error
Tags
· Dashboards · Widgets
41
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
dashboard_id required
The dashboard_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetDashboard_wi dgets > array
Error
Error
Tags
· Dashboards · Widgets
42
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
Type Header Header Path Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
dashboard_id required
The dashboard_id to search for
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetDashboard_wi dget
Error
Error
Tags
· Dashboards · Widgets
43
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
Type Header Header Path Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
dashboard_id required
The dashboard_id to modify
guid required
The guid to modify
Dashboard_wi
dget
The new values of the dashboard_widget
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
string
PutDashboard_widg et
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetDashboard_wi dget
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Dashboards · Widgets
44
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
Type Header Header Path Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
dashboard_id required
The dashboard_id to delete
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Dashboards · Widgets
45
GET /dashboards/{guid}
GET /dashboards/{guid}
Description
Retrieve the details of the dashboard with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetDashboard Error Error
Tags
· Dashboards
46
PUT /dashboards/{guid}
PUT /dashboards/{guid}
Description
Modify the values of the dashboard with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Dashboard required
The new values of the dashboard
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutDashboard
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetDashboard
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Dashboards
47
DELETE /dashboards/{guid}
DELETE /dashboards/{guid}
Description
Erase the dashboard with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Dashboards
48
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
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Docking_offse
ts
The details of the docking_offsets
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostDocking_offsets
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetDocking_offset s Error Error
Tags
· Docking_offsets
49
GET /docking_offsets
GET /docking_offsets
Description
Retrieve the list of docking offsets
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetDocking_offset s > array
Error
Error
Tags
· Docking_offsets
50
GET /docking_offsets/{guid}
GET /docking_offsets/{guid}
Description
Retrieve the details of the docking offset with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetDocking_offset Error Error
Tags
· Docking_offsets
51
PUT /docking_offsets/{guid}
PUT /docking_offsets/{guid}
Description
Modify the values of the docking offset with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Docking_offse
t
The new values of the docking_offset
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
PutDocking_offset
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetDocking_offset
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Docking_offsets
52
DELETE /docking_offsets/{guid}
DELETE /docking_offsets/{guid}
Description
Erase the docking offset with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Docking_offsets
53
POST /factory_reset
POST /factory_reset
Description
Clean and migrate the database. Keep hardware configurations
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Factory_reset required
The details of the factory_reset
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostFactory_reset
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetFactory_reset Error Error
Tags
· Factory_reset
54
GET /hook/brake
GET /hook/brake
Description
Retrieve the state of the Hook brake
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetHook_brake Error Error
Tags
· Brake · Hook
55
PUT /hook/brake
PUT /hook/brake
Description
Activate or release the Hook brake
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Hook_brake required
The new values of the hook_brake
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PutHook_brake
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetHook_brake
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Brake · Hook
56
GET /hook/gripper
GET /hook/gripper
Description
Retrieve the state of the Hook gripper
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetHook_gripper Error Error
Tags
· Gripper · Hook
57
PUT /hook/gripper
PUT /hook/gripper
Description
Open or close the Hook gripper
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Hook_gripper required
The new values of the hook_gripper
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PutHook_gripper
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetHook_gripper
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Gripper · Hook
58
GET /hook/height
GET /hook/height
Description
Retrieve the height of the Hook
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetHook_height Error Error
Tags
· Height · Hook
59
PUT /hook/height
PUT /hook/height
Description
Modify the height of the Hook
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Hook_height required
The new values of the hook_height
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PutHook_height
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetHook_height
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Height · Hook
60
GET /hook/status
GET /hook/status
Description
Retrieve the extended status of the Hook
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetHook Error Error
Tags
· Hook · Status
61
GET /hw/export
GET /hw/export
Description
Download a file containing the hardware configuration of the robot
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetHw_config_exp ort
Error
Error
Tags
· Export · Hw
62
POST /hw/import
POST /hw/import
Description
Import the hardware configuration contained in the file into the robot
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Hw_config_im
port
The details of the hw_config_import
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostHw_config_impo rt
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetHw_config_imp ort Error Error
Tags
· Hw · Import
63
POST /io_modules
POST /io_modules
Description
Add a new IO module
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Io_modules required
The details of the io_modules
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostIo_modules
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetIo_modules Error Error
Tags
· Io_modules
64
GET /io_modules
GET /io_modules
Description
Retrieve the list of configured IO modules
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetIo_modules > array
Error
Error
Tags
· Io_modules
65
GET /io_modules/{guid}
GET /io_modules/{guid}
Description
Retrieve the details about a IO device with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetIo_module Error Error
Tags
· Io_modules
66
PUT /io_modules/{guid}
PUT /io_modules/{guid}
Description
Modify the values of the IO device with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Io_module required
The new values of the io_module
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutIo_module
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetIo_module
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Io_modules
67
DELETE /io_modules/{guid}
DELETE /io_modules/{guid}
Description
Erase the IO device with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Io_modules
68
POST /io_modules/{guid}/status
POST /io_modules/{guid}/status
Description
Connect to theIO module with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to add the new resource to
Io_module_sta
tus
The details of the io_module_status
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PostIo_module_statu s
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetIo_module_stat us Error Error
Tags
· Io_modules · Status
69
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetIo_module_stat us
Error
Error
Tags
· Io_modules · Status
70
PUT /io_modules/{guid}/status
PUT /io_modules/{guid}/status
Description
Modify the outputs of the connected IO module with specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Io_module_sta
tus
The new values of the io_module_status
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
PutIo_module_status
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetIo_module_stat us
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Io_modules · Status
71
DELETE /io_modules/{guid}/status
DELETE /io_modules/{guid}/status
Description
Disconnect from the IO module with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Io_modules · Status
72
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
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Error_reports required
The details of the error_reports
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostError_reports
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetError_reports Error Error
Tags
· Error_reports · Log
73
GET /log/error_reports
GET /log/error_reports
Description
Retrieve the list of error reports
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetError_reports Error Error
Tags
· Error_reports · Log
74
DELETE /log/error_reports
DELETE /log/error_reports
Description
Erase ALL the error reports
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Error_reports · Log
75
GET /log/error_reports/{id}
GET /log/error_reports/{id}
Description
Retrieve the details about the error report with the specified ID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetError_report Error Error
Tags
· Error_reports · Log
76
DELETE /log/error_reports/{id}
DELETE /log/error_reports/{id}
Description
Erase the error report with the specified ID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Error_reports · Log
77
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetError_report_d ownload
Error
Error
Tags
· Download · Error_reports · Log
78
POST /maps
POST /maps
Description
Add a new map
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Maps required
The details of the maps
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostMaps
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetMaps Error Error
Tags
· Maps
79
GET /maps
GET /maps
Description
Retrieve the list of maps
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
< GetMaps > array Error Error
Tags
· Maps
80
GET /maps/{guid}
GET /maps/{guid}
Description
Retrieve the details about the map with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetMap Error Error
Tags
· Maps
81
PUT /maps/{guid}
PUT /maps/{guid}
Description
Modify the values of the map with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Map required
The new values of the map
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutMap
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetMap
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Maps
82
DELETE /maps/{guid}
DELETE /maps/{guid}
Description
Erase the map with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Maps
83
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
map_id required
The map_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMap_area_eve nt > array
Error
Error
Tags
· Area_events · Maps
84
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
map_id required
The map_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMap_path_guid es > array
Error
Error
Tags
· Maps · Path_guides
85
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
map_id required
The map_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMap_paths > array
Error
Error
Tags
· Maps · Paths
86
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
map_id required
The map_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMap_positions > array
Error
Error
Tags
· Maps · Positions
87
POST /mission_groups
POST /mission_groups
Description
Add a new mission group
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Mission_group
s
The details of the mission_groups
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostMission_groups
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetMission_group s Error Error
Tags
· Mission_groups
88
GET /mission_groups
GET /mission_groups
Description
Retrieve the list of mission groups
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMission_group s > array
Error
Error
Tags
· Mission_groups
89
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
group_id required
The group_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetGroup_mission s > array
Error
Error
Tags
· Mission_groups · Missions
90
GET /mission_groups/{guid}
GET /mission_groups/{guid}
Description
Retrieve the details about the mission group with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetMission_group Error Error
Tags
· Mission_groups
91
PUT /mission_groups/{guid}
PUT /mission_groups/{guid}
Description
Modify the values of the mission group with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Mission_group required
The new values of the mission_group
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutMission_group
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetMission_group
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Mission_groups
92
DELETE /mission_groups/{guid}
DELETE /mission_groups/{guid}
Description
Erase the mission group with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Mission_groups
93
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
mission_group
_id
The mission_group_id to search for
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetGroup_action_ definition
Error
Error
Tags
· Actions · Mission_groups
94
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
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Mission_queu
es
The details of the mission_queues
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostMission_queues
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetMission_queue s Error Error
Tags
· Mission_queue
95
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
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMission_queue s > array
Error
Error
Tags
· Mission_queue
96
DELETE /mission_queue
DELETE /mission_queue
Description
Abort all the pending and executing missions from the mission queue
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Mission_queue
97
GET /mission_queue/{id}
GET /mission_queue/{id}
Description
Retrieve the details about the mission with the specified ID in the mission queue
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetMission_queue Error Error
Tags
· Mission_queue
98
PUT /mission_queue/{id}
PUT /mission_queue/{id}
Description
Modify the values of the mission with the specified ID in the mission queue
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to modify
Mission_queu
e
The new values of the mission_queue
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) integer (int32)
PutMission_queue
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetMission_queue
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Mission_queue
99
DELETE /mission_queue/{id}
DELETE /mission_queue/{id}
Description
Abort the mission with the specified ID in the mission queue
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Mission_queue
100
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
mission_queu
e_id
The mission_queue_id to search for
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetMission_queue _actions
Error
Error
Tags
· Actions · Mission_queue
101
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
Type Header Header Path Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
mission_queu
e_id
The mission_queue_id to search for
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) integer (int32)
integer (int32)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetMission_queue _action
Error
Error
Tags
· Actions · Mission_queue
102
POST /missions
POST /missions
Description
Add a new mission
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Missions required
The details of the missions
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostMissions
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetMissions Error Error
Tags
· Missions
103
GET /missions
GET /missions
Description
Retrieve the list of missions
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMissions > array
Error
Error
Tags
· Missions
104
GET /missions/{guid}
GET /missions/{guid}
Description
Retrieve the details about the mission with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetMission Error Error
Tags
· Missions
105
PUT /missions/{guid}
PUT /missions/{guid}
Description
Modify the values of the mission with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Mission required
The new values of the mission
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutMission
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetMission
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Missions
106
DELETE /missions/{guid}
DELETE /missions/{guid}
Description
Erase the mission with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Missions
107
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMission_definit ion > array
Error
Error
Tags
· Definition · Missions
108
POST /missions/{mission_id}/actions
POST /missions/{mission_id}/actions
Description
Add a new action to the mission with the specified mission ID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
mission_id required
The mission_id to add the new resource to
Mission_actio
ns
The details of the mission_actions
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
PostMission_actions
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetMission_action s Error Error
Tags
· Actions · Missions
109
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
mission_id required
The mission_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetMission_action s > array
Error
Error
Tags
· Actions · Missions
110
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
Type Header Header Path Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
mission_id required
The mission_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetMission_action Error Error
Tags
· Actions · Missions
111
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
Type Header Header Path Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
mission_id required
The mission_id to modify
Mission_actio
n
The new values of the mission_action
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string string
PutMission_action
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetMission_action
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Actions · Missions
112
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
Type Header Header Path Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
mission_id required
The mission_id to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Actions · Missions
113
GET /modbus
GET /modbus
Description
Retrieve the modbus registers linked to actions
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetModbus Error Error
Tags
· Modbus
114
POST /modbus/missions
POST /modbus/missions
Description
Create a new link between a coil and a mission
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Modbus_missi
ons
The details of the modbus_missions
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostModbus_mission s
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetModbus_missio ns Error Error
Tags
· Missions · Modbus
115
GET /modbus/missions
GET /modbus/missions
Description
Retrieve the list of coils that can trigger a mission
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetModbus_missio ns > array
Error
Error
Tags
· Missions · Modbus
116
GET /modbus/missions/{guid}
GET /modbus/missions/{guid}
Description
Retrieve the details about the mission linked with the coil
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetModbus_missio n
Error
Error
Tags
· Missions · Modbus
117
PUT /modbus/missions/{guid}
PUT /modbus/missions/{guid}
Description
Modify the values of the modbus mission with the specified ID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Modbus_missi
on
The new values of the modbus_mission
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
PutModbus_mission
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetModbus_missio n
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Missions · Modbus
118
DELETE /modbus/missions/{guid}
DELETE /modbus/missions/{guid}
Description
Delete the specified ID on the the modbus mission table
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Missions · Modbus
119
GET /modbus/{id}
GET /modbus/{id}
Description
Retrieve the modbus registers linked to an action
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetModbu Error Error
Tags
· Modbus
120
POST /path_guides
POST /path_guides
Description
Add a new path guide
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Path_guides required
The details of the path_guides
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostPath_guides
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetPath_guides Error Error
Tags
· Path_guides
121
GET /path_guides
GET /path_guides
Description
Retrieve the list of path guides
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetPath_guides > array
Error
Error
Tags
· Path_guides
122
GET /path_guides/{guid}
GET /path_guides/{guid}
Description
Retrieve the path guide with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetPath_guide Error Error
Tags
· Path_guides
123
PUT /path_guides/{guid}
PUT /path_guides/{guid}
Description
Modify the values of the path guide with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Path_guide required
The new values of the path_guide
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutPath_guide
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetPath_guide
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Path_guides
124
DELETE /path_guides/{guid}
DELETE /path_guides/{guid}
Description
Erase the path guide with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Path_guides
125
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
path_guide_gu
id
The path_guide_guid to search for
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetPath_guide_opt ions
Error
Error
Tags
· Options · Path_guides
126
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
Type Header Header Path Body
Name
Description
Schema
AcceptLanguage required
Language header
enum (UI_API_LANGUAGE)
Authorization required
Authorization header
enum (UI_API_KEY)
path_guide_gu
id
The path_guide_guid to add the new resource to string
required
Path_guide_po
sitions
The details of the path_guide_positions
required
PostPath_guide_posit ions
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetPath_guide_pos itions Error Error
Tags
· Path_guides · Positions
127
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
path_guide_gu
id
The path_guide_guid to search for
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetPath_guide_pos itions > array
Error
Error
Tags
· Path_guides · Positions
128
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
Type Header Header Path Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
path_guide_gu
id
The path_guide_guid to search for
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetPath_guide_pos ition
Error
Error
Tags
· Path_guides · Positions
129
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
Type Header Header Path Path
Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
path_guide_gu
id
The path_guide_guid to modify
required
Path_guide_po
sition
The new values of the path_guide_position
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
string
PutPath_guide_positi on
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetPath_guide_pos ition
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Path_guides · Positions
130
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
Type Header Header Path Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
path_guide_gu
id
The path_guide_guid to delete
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Path_guides · Positions
131
POST /path_guides_positions
POST /path_guides_positions
Description
Add a new position in a path guide
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Path_guides_p
ositions
The details of the path_guides_positions
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostPath_guides_pos itions
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetPath_guides_po sitions Error Error
Tags
· Path_guides_positions
132
GET /path_guides_positions
GET /path_guides_positions
Description
Retrieve the list of positions used for path guides
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetPath_guides_po sitions > array
Error
Error
Tags
· Path_guides_positions
133
GET /path_guides_positions/{guid}
GET /path_guides_positions/{guid}
Description
Retrieve the position for path guides with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetPath_guides_po sition
Error
Error
Tags
· Path_guides_positions
134
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
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Path_guides_p
osition
The new values of the path_guides_position
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutPath_guides_posit ion
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetPath_guides_po sition
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Path_guides_positions
135
DELETE /path_guides_positions/{guid}
DELETE /path_guides_positions/{guid}
Description
Erase the path guide position with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Path_guides_positions
136
POST /path_guides_precalc
POST /path_guides_precalc
Description
Start/stop precalculation of the specified path guide
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Path_guides_p
recalc
The details of the path_guides_precalc
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostPath_guides_pre calc
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetPath_guides_pr ecalc Error Error
Tags
· Path_guides_precalc
137
GET /path_guides_precalc
GET /path_guides_precalc
Description
Retrieve the status of path guides precalculation
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetPath_guides_pr ecalc
Error
Error
Tags
· Path_guides_precalc
138
POST /paths
POST /paths
Description
Add a new path
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Paths required
The details of the paths
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostPaths
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetPaths Error Error
Tags
· Paths
139
GET /paths
GET /paths
Description
Retrieve the list of paths
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
< GetPaths > array Error Error
Tags
· Paths
140
GET /paths/{guid}
GET /paths/{guid}
Description
Retrieve the path with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetPath Error Error
Tags
· Paths
141
PUT /paths/{guid}
PUT /paths/{guid}
Description
Modify the values of the path with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Path required
The new values of the path
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutPath
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetPath
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Paths
142
DELETE /paths/{guid}
DELETE /paths/{guid}
Description
Erase the path with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Paths
143
GET /permissions/{guid}
GET /permissions/{guid}
Description
Retrieve the details about the permission with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetPermission Error Error
Tags
· Permissions
144
PUT /permissions/{guid}
PUT /permissions/{guid}
Description
Modify the values of the permission with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetPermission
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Permissions
145
DELETE /permissions/{guid}
DELETE /permissions/{guid}
Description
Erase the permission with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Permissions
146
POST /position_transition_lists
POST /position_transition_lists
Description
Add a new position transition list
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Position_trans
ition_lists
The details of the position_transition_lists
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostPosition_transiti on_lists
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetPosition_transi tion_lists Error Error
Tags
· Position_transition_lists
147
GET /position_transition_lists
GET /position_transition_lists
Description
Retrieve the list of position transition lists
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetPosition_transi tion_lists
Error
Error
Tags
· Position_transition_lists
148
GET /position_transition_lists/{guid}
GET /position_transition_lists/{guid}
Description
Retrieve the details about the position transition list with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetPosition_transi tion_list
Error
Error
Tags
· Position_transition_lists
149
PUT /position_transition_lists/{guid}
PUT /position_transition_lists/{guid}
Description
Modify the values of the position transition list with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Position_trans
ition_list
The new values of the position_transition_list
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutPosition_transitio n_list
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetPosition_transi tion_list
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Position_transition_lists
150
DELETE /position_transition_lists/{guid}
DELETE /position_transition_lists/{guid}
Description
Erase the position transition list with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Position_transition_lists
151
GET /position_types
GET /position_types
Description
Retrieve a list of possible position types
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetPosition_types > array
Error
Error
Tags
· Position_types
152
GET /position_types/{id}
GET /position_types/{id}
Description
Retrieve the details about the position type with the specified ID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetPosition_type Error Error
Tags
· Position_types
153
POST /positions
POST /positions
Description
Add a new position
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Positions required
The details of the positions
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostPositions
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetPositions Error Error
Tags
· Positions
154
GET /positions
GET /positions
Description
Retrieve the list of positions
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetPositions > array
Error
Error
Tags
· Positions
155
GET /positions/{guid}
GET /positions/{guid}
Description
Retrieve the details about the position with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetPosition Error Error
Tags
· Positions
156
PUT /positions/{guid}
PUT /positions/{guid}
Description
Modify the values of the position with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Position required
The new values of the position
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutPosition
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetPosition
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Positions
157
DELETE /positions/{guid}
DELETE /positions/{guid}
Description
Erase the position with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Positions
158
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
parent_guid required
The parent_guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetHelper_positio ns > array
Error
Error
Tags
· Helper_positions · Positions
159
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
pos_id required
The pos_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetPos_docking_of fsets > array
Error
Error
Tags
· Docking_offsets · Positions
160
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
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetRegisters > array
Error
Error
Tags
· Registers
161
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
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to add the new resource to
Register required
The details of the register
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
PostRegister
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetRegister Error Error
Tags
· Registers
162
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetRegister Error Error
Tags
· Registers
163
PUT /registers/{id}
PUT /registers/{id}
Description
Modify the value of the PLC register with the specified ID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to modify
Register required
The new values of the register
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
PutRegister
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetRegister
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Registers
164
GET /remote_support
GET /remote_support
Description
Retrieve the status of the remote support connection
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetRemote_suppor t
Error
Error
Tags
· Remote_support
165
PUT /remote_support
PUT /remote_support
Description
Modify the remote support connection timeout
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Remote_suppo
rt
The new values of the remote_support
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PutRemote_support
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetRemote_suppor t
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Remote_support
166
GET /remote_support/log
GET /remote_support/log
Description
Retrieve the list with the actions performed by the remote support controller
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetRemote_suppor t_log
Error
Error
Tags
· Log · Remote_support
167
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
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Robots required
The details of the robots
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostRobots
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetRobots Error Error
Tags
· Robots
168
POST /service_book
POST /service_book
Description
Add a service book note
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Service_books required
The details of the service_books
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostService_books
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetService_books Error Error
Tags
· Service_book
169
GET /service_book
GET /service_book
Description
Retrieve service book entries accessible by user
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetService_books Error Error
Tags
· Service_book
170
GET /service_book/{guid}
GET /service_book/{guid}
Description
Retrieve note with the GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetService_book Error Error
Tags
· Service_book
171
DELETE /service_book/{guid}
DELETE /service_book/{guid}
Description
Erase the note with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Service_book
172
POST /sessions
POST /sessions
Description
Add a new session
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Sessions required
The details of the sessions
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostSessions
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetSessions Error Error
Tags
· Sessions
173
GET /sessions
GET /sessions
Description
Retrieve the list of sessions
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSessions > array
Error
Error
Tags
· Sessions
174
POST /sessions/import
POST /sessions/import
Description
Import the session contained in the file
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Session_impor
t
The details of the session_import
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostSession_import
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetSession_import Error Error
Tags
· Import · Sessions
175
GET /sessions/{guid}
GET /sessions/{guid}
Description
Retrieve the details about the session with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetSession Error Error
Tags
· Sessions
176
PUT /sessions/{guid}
PUT /sessions/{guid}
Description
Modify the values of the session with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Session required
The new values of the session
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutSession
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetSession
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Sessions
177
DELETE /sessions/{guid}
DELETE /sessions/{guid}
Description
Erase the session with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Sessions
178
GET /sessions/{guid}/export
GET /sessions/{guid}/export
Description
Download a file containing the session with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetSession_export Error Error
Tags
· Export · Sessions
179
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
session_id required
The session_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSession_maps > array
Error
Error
Tags
· Maps · Sessions
180
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
session_id required
The session_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSession_missio ns > array
Error
Error
Tags
· Missions · Sessions
181
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
session_id required
The session_id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetPosition_transi tion_list_from_sess ion
Error
Error
Tags
· Position_transition_lists · Sessions
182
GET /setting_groups
GET /setting_groups
Description
Retrieve a list with the settings groups
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSetting_groups > array
Error
Error
Tags
· Setting_groups
183
GET /setting_groups/{id}
GET /setting_groups/{id}
Description
Retrieve the details about the settings group with the specified ID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetSetting_group Error Error
Tags
· Setting_groups
184
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
settings_group
_id
The settings_group_id to search for
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSetting_group_ settings > array
Error
Error
Tags
· Setting_groups · Settings
185
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
settings_group
_id
The settings_group_id to search for
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
integer (int32)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSetting_group_ advanced_settings > array
Error
Error
Tags
· Advanced · Setting_groups · Settings
186
GET /settings
GET /settings
Description
Retrieve a list with the settings
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSettings > array
Error
Error
Tags
· Settings
187
GET /settings/advanced
GET /settings/advanced
Description
Retrieve the list with the advanced settings
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSettings_advan ced > array
Error
Error
Tags
· Advanced · Settings
188
GET /settings/advanced/{id}
GET /settings/advanced/{id}
Description
Retrieve the details of the advanced setting with the specified ID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetSetting_advanc ed
Error
Error
Tags
· Advanced · Settings
189
PUT /settings/advanced/{id}
PUT /settings/advanced/{id}
Description
Modify the values of the advanced setting with the specified ID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to modify
Setting_advan
ced
The new values of the setting_advanced
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
PutSetting_advanced
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetSetting_advanc ed
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Advanced · Settings
190
GET /settings/{id}
GET /settings/{id}
Description
Retrieve the details of the setting with the specified ID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetSetting Error Error
Tags
· Settings
191
PUT /settings/{id}
PUT /settings/{id}
Description
Modify the values of the setting with the specified ID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
id required
The id to modify
Setting required
The new values of the setting
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutSetting
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetSetting
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Settings
192
POST /shelf_types
POST /shelf_types
Description
Add a new shelf type
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Shelf_types required
The details of the shelf_types
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostShelf_types
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetShelf_types Error Error
Tags
· Shelf_types
193
GET /shelf_types
GET /shelf_types
Description
Retrieve the list of shelf types
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetShelf_types > array
Error
Error
Tags
· Shelf_types
194
GET /shelf_types/{guid}
GET /shelf_types/{guid}
Description
Retrieve the details about the shelf type with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetShelf_type Error Error
Tags
· Shelf_types
195
PUT /shelf_types/{guid}
PUT /shelf_types/{guid}
Description
Modify the values of the shelf type with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Shelf_type required
The new values of the shelf_type
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutShelf_type
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetShelf_type
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Shelf_types
196
DELETE /shelf_types/{guid}
DELETE /shelf_types/{guid}
Description
Erase the shelf type with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Shelf_types
197
POST /software/backups
POST /software/backups
Description
Create a new software backup
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetSoftware_back ups Error Error
Tags
· Backups · Software
198
GET /software/backups
GET /software/backups
Description
Retrieve the list with all the software backups
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSoftware_back ups > array
Error
Error
Tags
· Backups · Software
199
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to add the new resource to
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetSoftware_back up Error Error
Tags
· Backups · Software
200
GET /software/backups/{guid}
GET /software/backups/{guid}
Description
Retrieve the details about the software backup with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetSoftware_back up
Error
Error
Tags
· Backups · Software
201
DELETE /software/backups/{guid}
DELETE /software/backups/{guid}
Description
Erase the software backup with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Backups · Software
202
GET /software/lock
GET /software/lock
Description
Retrieve the status of the software lock
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSoftware_lock_ self > array
Error
Error
Tags
· Lock · Software
203
PUT /software/lock
PUT /software/lock
Description
Modify the software lock
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Software_lock
_self
The new values of the software_lock_self
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PutSoftware_lock_sel f
Responses
HTTP Code 200
400 404
Description
Schema
The element has been modified successfully
GetSoftware_lock_ self
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Lock · Software
204
GET /software/logs
GET /software/logs
Description
Retrieve the list of software upgrade logs
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSoftware_logs > array
Error
Error
Tags
· Logs · Software
205
GET /software/logs/{guid}
GET /software/logs/{guid}
Description
Retrieve the details about the software upgrade log with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetSoftware_log Error Error
Tags
· Logs · Software
206
POST /software/upgrades
POST /software/upgrades
Description
Upgrade with the provided upgrade file
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetSoftware_upgr ades Error Error
Tags
· Software · Upgrades
207
GET /software/upgrades
GET /software/upgrades
Description
Retrieve a list of the software upgrade performed
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSoftware_upgr ades > array
Error
Error
Tags
· Software · Upgrades
208
POST /software/upgrades/{guid}
POST /software/upgrades/{guid}
Description
Upgrade to the version of the upgrade file with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to add the new resource to
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetSoftware_upgr ade Error Error
Tags
· Software · Upgrades
209
GET /software/upgrades/{guid}
GET /software/upgrades/{guid}
Description
Retrieve the details of the software upgrade with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetSoftware_upgr ade
Error
Error
Tags
· Software · Upgrades
210
DELETE /software/upgrades/{guid}
DELETE /software/upgrades/{guid}
Description
Erase the upgrade file with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Software · Upgrades
211
POST /sounds
POST /sounds
Description
Add a new sound
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Sounds required
The details of the sounds
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostSounds
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetSounds Error Error
Tags
· Sounds
212
GET /sounds
GET /sounds
Description
Retrieve the list of sounds
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSounds > array
Error
Error
Tags
· Sounds
213
GET /sounds/{guid}
GET /sounds/{guid}
Description
Retrieve the details about the sound with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetSound Error Error
Tags
· Sounds
214
PUT /sounds/{guid}
PUT /sounds/{guid}
Description
Modify the values of the sound with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
Sound required
The new values of the sound
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutSound
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetSound
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Sounds
215
DELETE /sounds/{guid}
DELETE /sounds/{guid}
Description
Erase the sound with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Sounds
216
GET /sounds/{guid}/stream
GET /sounds/{guid}/stream
Description
Download the sound file of the sound with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetSound_stream > array
Error
Error
Tags
· Sounds · Stream
217
GET /statistics/distance
GET /statistics/distance
Description
Retrieve the list with the distance driven by the robot at different dates and times
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetDistance_statist ics
Error
Error
Tags
· Distance · Statistics
218
GET /status
GET /status
Description
Retrieve the status
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetStatus Error Error
Tags
· Status
219
PUT /status
PUT /status
Description
Modify the status
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Status required
The new values of the status
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PutStatus
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetStatus
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Status
220
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
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetSystem_info Error Error
Tags
· Info · System
221
POST /user_groups
POST /user_groups
Description
Add a new user group
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
User_groups required
The details of the user_groups
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostUser_groups
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetUser_groups Error Error
Tags
· User_groups
222
GET /user_groups
GET /user_groups
Description
Retrieve the list of user groups
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetUser_groups > array
Error
Error
Tags
· User_groups
223
GET /user_groups/{guid}
GET /user_groups/{guid}
Description
Retrieve the details about the user group with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetUser_group Error Error
Tags
· User_groups
224
PUT /user_groups/{guid}
PUT /user_groups/{guid}
Description
Modify the values of the user group with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
User_group required
The new values of the user_group
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutUser_group
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetUser_group
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· User_groups
225
DELETE /user_groups/{guid}
DELETE /user_groups/{guid}
Description
Erase the user group with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· User_groups
226
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
Type Header Header Path Body
Name
Description
Schema
AcceptLanguage required
Language header
enum (UI_API_LANGUAGE)
Authorization required
Authorization header
enum (UI_API_KEY)
user_group_gu
id
The user_group_guid to add the new resource to string
required
User_group_p
ermission
The details of the user_group_permission
required
PostUser_group_per mission
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetUser_group_pe rmission Error Error
Tags
· Permissions · User_groups
227
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
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
user_group_gu
id
The user_group_guid to search for
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetUser_group_pe rmission > array
Error
Error
Tags
· Permissions · User_groups
228
POST /users
POST /users
Description
Add a new user
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Users required
The details of the users
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostUsers
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetUsers Error Error
Tags
· Users
229
GET /users
GET /users
Description
Retrieve the list of users
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
< GetUsers > array Error Error
Tags
· Users
230
GET /users/me
GET /users/me
Description
Retrieve the details about the user currently authorized in the API
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
< GetMe > array Error Error
Tags
· Me · Users
231
PUT /users/me
PUT /users/me
Description
Modify the values of the user currently authorized in the API
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Me required
The new values of the me
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PutMe
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetMe
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Me · Users
232
GET /users/me/permissions
GET /users/me/permissions
Description
Retrieve the permission of the user currently authorized in the API
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetUser_me_perm issions > array
Error
Error
Tags
· Me · Permissions · Users
233
GET /users/{guid}
GET /users/{guid}
Description
Retrieve the details about the user with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetUser Error Error
Tags
· Users
234
PUT /users/{guid}
PUT /users/{guid}
Description
Modify the values of the user with the specified GUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to modify
User required
The new values of the user
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
PutUser
Responses
HTTP Code 200
400
404
Description
Schema
The element has been modified successfully
GetUser
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Users
235
DELETE /users/{guid}
DELETE /users/{guid}
Description
Erase the user with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Users
236
GET /wifi
GET /wifi
Description
Retrieve the URLs to the 3 WiFi related endpoints
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetWifi Error Error
Tags
· Wifi
237
POST /wifi/connections
POST /wifi/connections
Description
Add a new WiFi network configuration
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Wifi_connecti
ons
The details of the wifi_connections
required
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostWifi_connection s
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetWifi_connectio ns Error Error
Tags
· Connections · Wifi
238
GET /wifi/connections
GET /wifi/connections
Description
Retrieve the list of WiFi networks already configured
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetWifi_connectio ns > array
Error
Error
Tags
· Connections · Wifi
239
POST /wifi/connections/{uuid}
POST /wifi/connections/{uuid}
Description
Connect to the network with the specified UUID
Parameters
Type Header Header Path Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
uuid required
The uuid to add the new resource to
Wifi_connecti
on
The details of the wifi_connection
required
Schema enum (UI_API_LANGUAGE) enum (UI_API_KEY) string
PostWifi_connection
Responses
HTTP Code 201
400 409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetWifi_connectio n Error Error
Tags
· Connections · Wifi
240
GET /wifi/connections/{uuid}
GET /wifi/connections/{uuid}
Description
Retrieve the details about the WiFi network configuration with the specified UUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
uuid required
The uuid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400 404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
GetWifi_connectio n
Error
Error
Tags
· Connections · Wifi
241
DELETE /wifi/connections/{uuid}
DELETE /wifi/connections/{uuid}
Description
Erase the WiFi network configuration with the specified UUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
uuid required
The uuid to delete
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 204
400
404
Description
Schema
The element has been deleted successfully
No Content
Invalid filters or Invalid JSON or Argument error or Missing content type application/json on the header or Bad request or No fields
Error
Not found
Error
Tags
· Connections · Wifi
242
GET /wifi/networks
GET /wifi/networks
Description
Retrieve the list of WiFi networks available for the robot to connect
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code
200
400 404
Description
Schema
Successfully retrieved the list of elements
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits Not found
< GetWifi_networks > array
Error
Error
Tags
· Networks · Wifi
243
GET /wifi/networks/{guid}
GET /wifi/networks/{guid}
Description
Retrieve the details about the WiFi network with the specified GUID
Parameters
Type Header Header Path
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
guid required
The guid to search for
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
string
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetWifi_network Error Error
Tags
· Networks · Wifi
244
POST /world_model
POST /world_model
Description
Upload the world model with the existing robots, resources and positions and their respective locks
Parameters
Type Header Header Body
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
World_model required
The details of the world_model
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
PostWorld_model
Responses
HTTP Code 201
400
409
Description
The element has been created successfully Argument error or Missing content type application/json on the header or Bad request or Invalid JSON Duplicate entry
Schema GetWorld_model Error Error
Tags
· World_model
245
GET /world_model
GET /world_model
Description
Retrieve the information about the needed resources from the robot
Parameters
Type Header Header
Name
Description
AcceptLanguage required
Language header
Authorization required
Authorization header
Schema enum (UI_API_LANGUAGE)
enum (UI_API_KEY)
Responses
HTTP Code 200
400
404
Description
Schema
Successfully retrieve the specified element
Invalid ordering or Invalid filters or Wrong output fields or Invalid limits
Not found
GetWorld_model Error Error
Tags
· World_model
246
Definitions
Error
Name
Description
error_code optional
The error in machine format
error_human optional
The error in human friendly format
GetAction_definition
Name
action_type optional
description optional
help optional
mission_group_id optional
name optional
parameters optional
Schema string string string string string < object > array
GetAction_definitions
Name
action_type optional
description optional
help optional
mission_group_id optional
name optional
parameters optional
Schema string string string string string < object > array
Schema string string
247
GetArea_event
Name
Description
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
guid optional
The global id unique across robots that identifies this area event
map optional
The url to the map this area event belongs to
map_id optional
The id of the map this area event belongs to
name optional
A name associated with this area event
note optional
The possible note associated with this area event
polygon optional
The list of coordinates in the area event polygon
time optional
The end_time of the current update to the area
turn_around optional
Boolean indicating whether robot can turn in area
type_id optional
The type of area event
value optional
The possible value associated with this area event
Schema string string string string string string string < object > array string (date-time) boolean integer number
GetArea_events
Name
guid optional
map optional
type_id optional
url optional
Description
The global id unique across robots that identifies this area event
Schema string
The url to the map this area event belongs to
string
The type of area event
integer
The URL of the resource
string
GetBluetooth
248
Name
address optional
name optional
url optional
Description The mac address of the blueooth device The name of the bluetooth device The URL of the resource
GetBluetooth_relay
Name
Description
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
guid optional
The global unique id across robots that identifies this bluetooth device
hardware_id optional
The hardware id string for this bluetooth device
name optional
The name of the bluetooth device
type optional
Parameter to filter bluetooth devices
GetBluetooth_relays
Name
guid optional
name optional
type optional
url optional
Description The global unique id across robots that identifies this bluetooth device The name of the bluetooth device
Parameter to filter bluetooth devices
The URL of the resource
GetBluetooth_status
Type : object
GetCart
Schema string string string
Schema string string string string string string
Schema string string string string
249
Name
Description
cart_calibrati
on
The url to the calibration of this cart
optional
cart_calibrati
on_id
The id of the calibration for this cart has
optional
cart_type optional
The url to the type of this cart
cart_type_id optional
The id of the type of this cart
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
guid optional
The global id unique across robots that identifies this cart
name optional
The name of the cart
Schema string
string string string string string string string
GetCart_calibration
Name
Description
Schema
created_by optional
The url to the description of the type of this position
string
created_by_id optional
The global id of the user who created this entry
string
drive_height optional
The height of the hook when driving with carts of this cart calibration
integer
entry_height optional
The entry height of the hook for the cart calibration
integer
guid optional
The global id unique across robots that identifies this cart calibration
string
lock_height optional
The lock height of the hook for the cart calibration
integer
name optional
The name of the cart calibration
string
qw optional
The qw quaternion of the cart calibration
number (float)
qx optional
The qx quaternion of the cart calibration
number (float)
qy optional
The qy quaternion of the cart calibration
number (float)
250
Name
qz optional
standard optional
x optional
y optional
z optional
Description The qz quaternion of the cart calibration If the cart calibration is standard or not The offset in the x-coordinate of the cart calibration The offset in the y-coordinate of the cart calibration The offset in the z-coordinate of the cart calibration
Schema number (float) boolean number (float) number (float) number (float)
GetCart_calibrations
Name
guid optional
name optional
url optional
Description
The global id unique across robots that identifies this cart calibration
Schema string
The name of the cart calibration
string
The URL of the resource
string
GetCart_type
Name
Description
Schema
created_by optional
The url to the description of the type of this position
string
created_by_id optional
The global id of the user who created this entry
string
guid optional
The global id unique across robots that identifies this cart type
string
height optional
The height of carts of this type
number (float)
length optional
The length of carts of this type
number (float)
name optional
The name of the cart type
string
offset_locked_ wheels optional
The offset from the center of the robot to the locked wheels of carts of this type
number (float)
width optional
The width of carts of this type
number (float)
251
GetCart_types
Name
guid optional
name optional
url optional
Description
The global id unique across robots that identifies this cart type
Schema string
The name of the cart type
string
The URL of the resource
string
GetCarts
Name
Description
cart_calibrati
on
The url to the calibration of this cart
optional
cart_type optional
The url to the type of this cart
guid optional
The global id unique across robots that identifies this cart
name optional
The name of the cart
url optional
The URL of the resource
Schema string string string string string
GetChanges_me
Type : object
GetDashboard
Name
Description
created_by optional
The url to the user that created the dashboard
created_by_id optional
The global id of the user who created this entry
fleet_dashboa rd optional
guid optional
The global id unique across robots that identifies this dashboard
name optional
The name of this dashboard
Schema string string boolean string string
252
Name
widgets optional
Description
The url to the possible widgets. if the dashboard does not have any widgets then this field is empty
Schema string
GetDashboard_widget
Name
Description
dashboard optional
The url to the dashboard where this widget belongs.
dashboard_id optional
The guid of the dashboard this widget belongs to
guid optional
The global id unique across robots that identifies this widget
settings optional
Widgets configuration encoded base 64 in json
Schema string string string string
GetDashboard_widgets
Name
Description
dashboard_id optional
The guid of the dashboard this widget belongs to
guid optional
The global id unique across robots that identifies this widget
url optional
The URL of the resource
Schema string string string
GetDashboards
Name
guid optional
name optional
url optional
widgets optional
Description The global id unique across robots that identifies this dashboard
The name of this dashboard
Schema string string
The URL of the resource
The url to the possible widgets. if the dashboard does not have any widgets then this field is empty
string string
GetDistance_statistics
253
Name
date optional
distance optional
Schema string (date-time) number (float)
GetDocking_offset
Name
Description
Schema
guid optional
The global id unique across robots that identifies this docking offset
string
orientation_of
fset
The orientation offset with respect to the docking marker
optional
number (float)
pos_id optional
The global id refering to the position that this offset belongs to
string
position optional
The url to the position
string
x_offset optional
The x-offset with respect to the docking marker
number (float)
y_offset optional
The y-offset with respect to the docking marker
number (float)
GetDocking_offsets
Name
guid optional
position optional
url optional
Description The global id unique across robots that identifies this docking offset The url to the position
The URL of the resource
Schema string string string
GetError_report
Name
Description
description optional
download_url optional
The url to where the bag can be downloaded
id optional
Id of the autobag
Schema string string integer
254
Name
module optional
ready optional
time optional
Description The module that created the autolog Status of the rosbag The time where the autolog was created
GetError_report_download
Type : object
GetError_reports
Name
Description
description optional
download_url optional
The url to where the bag can be downloaded
id optional
Id of the autobag
module optional
The module that created the autolog
ready optional
Status of the rosbag
time optional
The time where the autolog was created
GetFactory_reset
Type : object
GetGroup_action_definition
Name
action_type optional
description optional
help optional
mission_group_id optional
Schema string string string string
Schema string boolean string (date-time)
Schema string string integer string boolean string (date-time)
255
Name
name optional
parameters optional
Schema string < object > array
GetGroup_missions
Name
guid optional
name optional
url optional
Description The global id unique across robots that identifies this mission The name of the mission
The URL of the resource
GetHelper_positions
Name
guid optional
map optional
name optional
type_id optional
url optional
Description The global id unique across robots that identifies this position The url to the map this position belongs to
The name of the position
The type of position. see the general description above
The URL of the resource
GetHook
Name
angle optional
available optional
brake optional
gripper optional
height optional
Description The angle of the hook arm Whether the hook data is available or not
Schema string string string
Schema string string string integer string
Schema number (float) boolean brake gripper height
256
Name
Description
qr_marker_na
me
The name of the last seen qr marker
optional
brake
Name
braked optional
state optional
state_string optional
Description Whether the hook brake is activated or not The state of the hook brake in machine format The state of the hook brake in human format
gripper
Name
closed optional
state optional
state_string optional
Description Whether the hook gripper is closed or not The state of the hook gripper in machine format The state of the hook gripper in human format
height
Name
height optional
state optional
state_string optional
Description The height of the hook in mm The state of the hook height control in machine format The state of the hook height control in human format
GetHook_brake
Name
braked optional
state optional
state_string optional
Description Whether the brake of the hook is active or not The state of the hook brake in machine format The state of the hook brake in human format
Schema string
Schema boolean integer string
Schema boolean integer string
Schema number (float) integer string
Schema boolean integer string
257
GetHook_gripper
Name
closed optional
state optional
state_string optional
Description Whether the gripper of the hook is closed or not The sate of the hook gripper in machine format The state of the hook gripper in human format
Schema boolean integer string
GetHook_height
Name
height optional
state optional
state_string optional
Description The height of the hook in mm The state of the hook actuator in machine format The state of the hook actuator in human format
Schema integer integer string
GetHw_config_export
Type : object
GetHw_config_import
Type : object
GetIo_module
Name
Description
address optional
The address for connecting to the device. it can be a mac address or an ip depending on the type of io module
created_by optional
The url to the description of the type of this io module
created_by_id optional
The global id of the user who created this entry
guid optional
The global unique id across robots that identifies this io module
name optional
The name of the io module
num_inputs optional
The number of inputs that the io module has
Schema string string string string string integer
258
Name
Description
num_outputs optional
The number or outputs that the io module has
type optional
The type of the io module. currently supported devices [bluetooth, wise].
Schema integer string
GetIo_module_status
Type : object
GetIo_modules
Name
guid optional
name optional
type optional
url optional
Description The global unique id across robots that identifies this io module
The name of the io module
The type of the io module. currently supported devices [bluetooth, wise].
The URL of the resource
Schema string string string string
GetMap
Name
Description
Schema
created_by optional
The url to the description of the type of this position
string
created_by_id optional
The global id of the user who created this entry
string
guid optional
The global id unique across robots that identifies this map string
map optional
If this map is navigation map or not
string (byte)
metadata optional
If this map is a web map or not
string (byte)
name optional
The name of the map
string
one_way_map optional
If this map is navigation map or not
string (byte)
origin_theta optional
The angle in the map of the center of the map relative to the robots position
number (float)
origin_x optional
The x-coordinate in the map of the center of the map relative to the robots position
number (float)
259
Name
origin_y optional
path_guides optional
paths optional
positions optional
resolution optional
session_id optional
Description The y-coordinate in the map of the center of the map relative to the robots position The url to the list of path guides in this map
The url to the list of paths in this map
The url to the list of positions in this map
The resolution of the map The global id unique across robots of the area containing this map
Schema number (float) string string string number (float) string
GetMap_area_event
Name
guid optional
map optional
type_id optional
url optional
Description
The global id unique across robots that identifies this area event
Schema string
The url to the map this area event belongs to
string
The type of area event
integer
The URL of the resource
string
GetMap_path_guides
Name
guid optional
name optional
url optional
Description
The global unique id across robots that identifies this path guide
Schema string
The name of the path guide
string
The URL of the resource
string
GetMap_paths
Name
goal_pos optional
guid optional
Description The url to the end position of the path
Schema string
The global id unique across robots that identifies this path string
260
Name
start_pos optional
url optional
Description The url to the start position of the path The URL of the resource
Schema string string
GetMap_positions
Name
guid optional
map optional
name optional
type_id optional
url optional
Description The global id unique across robots that identifies this position The url to the map this position belongs to
The name of the position
The type of position. see the general description above
The URL of the resource
Schema string string string integer string
GetMaps
Name
guid optional
name optional
url optional
Description
Schema
The global id unique across robots that identifies this map string
The name of the map
string
The URL of the resource
string
GetMe
Name
Description
guid optional
The global unique id across robots that identifies this user
name optional
The name of the user
url optional
The URL of the resource
user_group optional
Url for the user group this user is in
user_group_id optional
Global id of the user group this user is in
Schema string string string string string
261
GetMission
Name
Description
Schema
actions optional
The url to the list of actions contained in this mission
string
created_by optional
The url to the description of the type of this position
string
created_by_id optional
The global id of the user who created this entry
string
definition optional
The url to the list of input parameters this mission accepts string
description optional
The description of the mission
string
group_id optional
The id of the area this mission belongs to, or null if the mission belongs to all areas
string
guid optional
The global id unique across robots that identifies this mission
string
has_user_para
meters
Indicates if the mission has dynamic parameters
optional
boolean
hidden optional
If this mission is hidden in the mission list
boolean
name optional
The name of the mission
string
session_id optional
The id of the area this mission belongs to, or null if the mission belongs to all areas
string
valid optional
Indicates if the mission contains only existing submissions boolean
GetMission_action
Name
action_type optional
guid optional
mission_id optional
parameters optional
priority optional
Description The id of the type of action The global id unique across robots that identifies this mission The id of the mission the action belongs to
The priority of the action
Schema string string string string integer
262
Name
Description
scope_referen
ce
Reference to the scope in which the action belongs
optional
GetMission_actions
Name
action_type optional
guid optional
mission_id optional
parameters optional
priority optional
url optional
Description The id of the type of action The global id unique across robots that identifies this mission The id of the mission the action belongs to
The priority of the action The URL of the resource
GetMission_definition
Name
action_type optional
name optional
url optional
Description The URL of the resource
GetMission_group
Name
Description
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
feature optional
The name of the position
guid optional
The global id unique across robots that identifies this position
Schema string
Schema string string string string integer string
Schema string string string
Schema string string string string
263
Name
icon optional
name optional
priority optional
Description The name of the position The name of the position The name of the position
Schema string (byte) string integer
GetMission_groups
Name
guid optional
name optional
url optional
Description The global id unique across robots that identifies this position The name of the position
The URL of the resource
Schema string string string
GetMission_queue
Name
Description
Schema
actions optional
The list of parameters this mission queue entry accepts
string
control_posid optional
Global id of position used during control states
string
control_state optional
Mission control state. a value above zero indicates that the robot needs an external input in order to continue
integer
created_by optional
The url to the description of the type of this element
string
created_by_id optional
The global id of the user who created this entry
string
description optional
Inerited from mission description, when item was queued string
finished optional
The date and time when the mission was finished
string (date-time)
id optional
The id of the mission queue entry
integer
message optional
The last message produced by the actions in the mission list string
mission optional
The url to the mission that mission that was executed
string
mission_id optional
The global id of the mission that was executed
string
264
Name
ordered optional
parameters optional
priority optional
started optional
state optional
Description The date end time when the mission was queued
The id of the action The date and time when the missin was started The end state after the mission was executed
GetMission_queue_action
Name
Description
action_id optional
The id of the action
action_type optional
The name of the action
finished optional
The date and time when the action finished
id optional
The id of the action
message optional
The possible message produced by the action
mission_queu
e_id
The id of the action
optional
parameters optional
The list of parameters to the action
started optional
The date and time when the action was started
state optional
The end state after executing the action
url optional
GetMission_queue_actions
Name
action_id optional
Description The id of the action
Schema string (date-time) string integer string (date-time) string
Schema string string string (date-time) integer string integer < object > array string (date-time) string string
Schema string
265
Name
Description
action_type optional
The name of the action
finished optional
The date and time when the action finished
id optional
The id of the action
message optional
The possible message produced by the action
mission_queu
e_id
The id of the action
optional
parameters optional
The list of parameters to the action
started optional
The date and time when the action was started
state optional
The end state after executing the action
url optional
GetMission_queues
Name
id optional
state optional
url optional
Description The id of the mission queue entry The end state after the mission was executed The URL of the resource
GetMissions
Name
guid optional
name optional
url optional
Description The global id unique across robots that identifies this mission The name of the mission
The URL of the resource
Schema string string (date-time) integer string integer < object > array string (date-time) string string
Schema integer string string
Schema string string string
266
GetModbu
Name
data_type optional
description optional
id optional
permissions optional
registers optional
title optional
type optional
Description The data type needed A more detailed explanation of the attribute The id of the modbus entry If it is allowed to read or write this element The registers on the plc where the data will be stored A textual description of the desired element The endpoint to which the element refers
GetModbus
Name
data_type optional
description optional
id optional
permissions optional
registers optional
title optional
type optional
Description The data type needed A more detailed explanation of the attribute The id of the modbus entry If it is allowed to read or write this element The registers on the plc where the data will be stored A textual description of the desired element The endpoint to which the element refers
GetModbus_mission
Name
coil_id optional
created_by optional
Description
The id of the coil to trigger the mission
The url to the description of the type of this modbus mission
Schema string string integer string < object > array string string
Schema string string integer string < object > array string string
Schema integer string
267
Name
Description
created_by_id optional
The global id of the user who created this entry
guid optional
The global id unique across robots that identifies this modbus mission
id optional
The id of the modbus mission entry
mission optional
The url to the mission details
mission_id optional
The global id of the mission that was executed
name optional
A more detailed explanation of the attribute
parameters optional
Schema string string integer string string string string
GetModbus_missions
Name
coil_id optional
guid optional
url optional
Description The id of the coil to trigger the mission The global id unique across robots that identifies this modbus mission The URL of the resource
Schema integer string string
GetPath
Name
Description
autogenerated optional
If the path was autogenerated or not
footprint optional
The footprint of the robot for which this path was generated
goal_pos optional
The url to the end position of the path
goal_pos_id optional
The id of the end position of the path
guid optional
The global id unique across robots that identifies this path
last_used optional
The date and time of the last time this path was used
length optional
The length of the path in meters
Schema boolean string string string string string (date-time) number (float)
268
Name
map_crc optional
path optional
start_pos optional
start_pos_id optional
time optional
valid optional
Description The crc for the path A binary representation of the path The url to the start position of the path The id of the start position of the path The time it took to drive the path the first time If the path is valid or not
Schema string string (byte) string string number (float) boolean
GetPath_guide
Name
Description
Schema
created_by optional
The url to the description of the type of this element
string
created_by_id optional
The global unique id of the user that created this path guide string
goals_count optional
The number of goal positions in the path guide
integer
guid optional
The global unique id across robots that identifies this path guide
string
map_id optional
The global id of the map this path guide belongs to
string
name optional
The name of the path guide
string
options optional
The url to the list of position options for this path path
string
positions optional
The url to the list of positions used in this path guide
string
starts_count optional
The number of start positions in the path guide
integer
vias_count optional
The number of via positions in the path guide
integer
GetPath_guide_options
Name
goals optional
Description The list of options for goal positions
Schema < goals > array
269
Name starts optional vias optional
goals
Name name optional pos_guid optional
starts
Name name optional pos_guid optional
vias
Name name optional pos_guid optional
Description The list of options for start positions The list of options for via positions
Description The name of the position The global unique id across robots that identifies this position
Description The name of the position The global unique id across robots that identifies this position
Description The name of the position The global unique id across robots that identifies this position
Schema < starts > array < vias > array
Schema string string
Schema string string
Schema string string
GetPath_guide_position
Name
Description
Schema
guid optional
The global unique id across robots of the position in the list of path constraints positions
string
path_guide_gu id optional
The global unique id across robots of the path guide this position is related to
string
pos_guid optional
The global unique id across robots that identifies this position
string
pos_type optional
The type of position of the guide (start/via/goal)
string
priority optional
The order in which to follow the via positions in the path guide
integer
270
GetPath_guide_positions
Name
Description
Schema
guid optional
The global unique id across robots of the position in the list of path constraints positions
string
path_guide_gu id optional
The global unique id across robots of the path guide this position is related to
string
pos_type optional
The type of position of the guide (start/via/goal)
string
url optional
The URL of the resource
string
GetPath_guides
Name
guid optional
name optional
url optional
Description
The global unique id across robots that identifies this path guide
Schema string
The name of the path guide
string
The URL of the resource
string
GetPath_guides_position
Name
Description
Schema
guid optional
The global unique id across robots of the position in the list of path constraints positions
string
path_guide_gu id optional
The global unique id across robots of the path guide this position is related to
string
pos_guid optional
The global unique id across robots that identifies this position
string
pos_type optional
The type of position of the guide (start/via/goal)
string
priority optional
The order in which to follow the via positions in the path guide
integer
GetPath_guides_positions
Name
guid optional
Description
Schema
The global unique id across robots of the position in the list of path constraints positions
string
271
Name
Description
path_guide_gu id optional
The global unique id across robots of the path guide this position is related to
pos_type optional
The type of position of the guide (start/via/goal)
url optional
The URL of the resource
Schema string string string
GetPath_guides_precalc
Name
Description
active optional
Boolean indicating if a path guide precalculation is in progress
fail_count optional
The number of paths that was not possible to precalculate
message optional
Status message from the precalculation module
path_guide_gu id optional
The global unique id across robots that identifies the path guide being precalculated
success_count optional
The number of paths that has been successfully calculated
total_count optional
The number of total paths to calculate
Schema boolean integer string string integer integer
GetPaths
Name
goal_pos optional
guid optional
start_pos optional
url optional
Description The url to the end position of the path
Schema string
The global id unique across robots that identifies this path string
The url to the start position of the path
string
The URL of the resource
string
GetPermission
Name
endpoint optional
Description
Schema string
272
Name
Description
guid optional
The global unique id across robots that identifies this permission
permission_ty
pe
The permission type
optional
user_group_gu
id
The global id of the usergroup
optional
Schema string string
string
GetPos_docking_offsets
Name
guid optional
position optional
url optional
Description The global id unique across robots that identifies this docking offset The url to the position
The URL of the resource
Schema string string string
GetPosition
Name
Description
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
docking_offset s optional
The url to the possible docking offset. if the position does not have a docking offset then this field is empty
guid optional
The global id unique across robots that identifies this position
help_positions optional
map optional
The url to the map this position belongs to
map_id optional
The global id of the map this positions belongs to
name optional
The name of the position
orientation optional
The orientation of the position in degrees relative to origo of the underlying map
Schema string string
string
string string string string string number (float)
273
Name parent optional
parent_id optional
pos_x optional pos_y optional type optional type_id optional
Description
Schema
The url to the possible parent position. if the position does not have a parent position then this field is empty
string
The global id of the possible parent position of the current
position. a parent position is a position related to the
current position, for instance the parent position of a trolley left entry position is the actual trolley position. if the
string
position does not have a parent position then this field is
empty
The x-coordinate of the position relative to origo of the underlying map
number (float)
The y-coordinate of the position relative to origo of the underlying map
number (float)
The url to the description of the type of this position
string
The type of position. see the general description above
integer
GetPosition_transition_list
Name
Description
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
goal_pos_id optional
The id of the end position for the transition list
guid optional
The global id unique across robots that identifies this path
mission_id optional
The guid of the mission in the transition list
start_pos_id optional
The id of the start position for the transition list
Schema string string string string string string
GetPosition_transition_list_from_session
Name
Description
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
goal_pos_id optional
The id of the end position for the transition list
Schema string string string
274
Name
guid optional
mission_id optional
start_pos_id optional
Description
Schema
The global id unique across robots that identifies this path string
The guid of the mission in the transition list
string
The id of the start position for the transition list
string
GetPosition_transition_lists
Name
Description
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
goal_pos_id optional
The id of the end position for the transition list
guid optional
The global id unique across robots that identifies this path
mission_id optional
The guid of the mission in the transition list
start_pos_id optional
The id of the start position for the transition list
Schema string string string string string string
GetPosition_type
Name
Description
hidden optional
False if the position is not created by the user
id optional
Unique id for the position type
name optional
Name of the position type
reachable_for
_robot
True if the robot can actually go to that position
optional
Schema boolean integer string
boolean
GetPosition_types
Name
id optional
Description Unique id for the position type
Schema integer
275
Name
name optional
url optional
Description Name of the position type The URL of the resource
GetPositions
Name
guid optional
map optional
name optional
type_id optional
url optional
Description The global id unique across robots that identifies this position The url to the map this position belongs to
The name of the position
The type of position. see the general description above
The URL of the resource
GetRegister
Name
id optional
label optional
value optional
Description The index of the register A label for the register The value of the register
GetRegisters
Name
id optional
label optional
url optional
value optional
Description The index of the register A label for the register The URL of the resource The value of the register
Schema string string
Schema string string string integer string
Schema integer string number (float)
Schema integer string string number (float)
276
GetRemote_support
Type : object
GetRemote_support_log
Type : object
GetRobots
Type : object
GetService_book
Name
Description
created_at optional
Creation time of the service note
created_by optional
The url to the user
created_by_id optional
The user which created the log
created_by_na
me
The user name which created the log
optional
description optional
The sevice note
guid optional
The global unique id across robots that identifies this service note
owner_group optional
The url to the owner group
owner_group_
guid
The usergroup which owns the service book
optional
owner_group_
name
The group name which owns the log
optional
GetService_books
Name
created_at optional
created_by optional
Description Creation time of the service note The url to the user
Schema string string string string string string string string
string
Schema string string
277
Name
Description
created_by_id optional
The user which created the log
created_by_na
me
The user name which created the log
optional
description optional
The sevice note
guid optional
The global unique id across robots that identifies this service note
owner_group optional
The url to the owner group
owner_group_
guid
The usergroup which owns the service book
optional
owner_group_
name
The group name which owns the log
optional
Schema string string string string string string
string
GetSession
Name
Description
Schema
active optional
Boolean indicating whether the session is the active session in the fleet
boolean
created_by optional
The url to the description of the type of this position
string
created_by_id optional
The global id of the user who created this entry
string
description optional
A possible description of the area
string
export optional
string
guid optional
The global id unique across robots that identifies this area string
maps optional
The url to the list of maps that is in this area
string
name optional
The name of the area
string
GetSession_export
Type : object
278
GetSession_import
Type : object
GetSession_maps
Name
guid optional
name optional
url optional
Description
Schema
The global id unique across robots that identifies this map string
The name of the map
string
The URL of the resource
string
GetSession_missions
Name
guid optional
name optional
url optional
Description The global id unique across robots that identifies this mission The name of the mission
The URL of the resource
Schema string string string
GetSessions
Name
guid optional
name optional
url optional
Description
Schema
The global id unique across robots that identifies this area string
The name of the area
string
The URL of the resource
string
GetSetting
Name
constraints optional
default optional
description optional
Schema string string string
279
Name
fieldtype optional
full_name optional
id optional
name optional
parent_id optional
parent_name optional
parent_value optional
select_group optional
settings_group optional
settings_group_id optional
type optional
value optional
Schema string string integer string string string string integer string integer string string
GetSetting_advanced
Name
constraints optional
default optional
description optional
fieldtype optional
full_name optional
id optional
name optional
Schema string string string string string integer string
280
Name
parent_id optional
parent_name optional
parent_value optional
select_group optional
settings_group optional
settings_group_id optional
type optional
value optional
Schema string string string integer string integer string string
GetSetting_group
Name
advanced_settings_count optional
description optional
id optional
name optional
priority optional
settings_count optional
Schema integer string integer string integer integer
GetSetting_group_advanced_settings
Name
default optional
id optional
name optional
Description
Schema string integer string
281
Name
Description
parent_name optional
url optional
The URL of the resource
value optional
GetSetting_group_settings
Name
Description
default optional
id optional
name optional
parent_name optional
url optional
The URL of the resource
value optional
GetSetting_groups
Name
id optional
name optional
url optional
Description The URL of the resource
GetSettings
Name
default optional
id optional
name optional
Description
282
Schema string string string
Schema string integer string string string string
Schema integer string string
Schema string integer string
Name
Description
parent_name optional
url optional
The URL of the resource
value optional
Schema string string string
GetSettings_advanced
Name
Description
default optional
id optional
name optional
parent_name optional
url optional
The URL of the resource
value optional
Schema string integer string string string string
GetShelf_type
Name
Description
Schema
bar_distance optional
The distance between the side bars of shelves of this type
number (float)
bar_length optional
The length of the side bars of shelves of this type
number (float)
created_by optional
The url to the description of the type of this position
string
created_by_id optional
The global id of the user who created this entry
string
guid optional
The global id unique across robots that identifies this shelf type
string
height optional
The height of shelves of this type
number (float)
length optional
The length of shelves of this type
number (float)
name optional
The name of the shelf type
string
283
Name
offset_x optional
offset_y optional
width optional
Description The offset in the x-coordinate of shelf of this type The offset in the y-coordinate of shelves of this type The width of shelves of this type
Schema number (float) number (float) number (float)
GetShelf_types
Name
guid optional
name optional
url optional
Description
Schema
The global id unique across robots that identifies this shelf type
string
The name of the shelf type
string
The URL of the resource
string
GetSoftware_backup
Name
date optional
guid optional
state optional
version optional
Description The date where the backup was created The guid of the software backup The state of the software backup The version of the software backup
Schema string (date-time) string string string
GetSoftware_backups
Name
date optional
guid optional
state optional
url optional
version optional
Description The date where the backup was created The guid of the software backup The state of the software backup The URL of the resource The version of the software backup
Schema string (date-time) string string string string
284
GetSoftware_lock_self
Name
Description
lock optional
Lock applied
lock_pending optional
Lock pending
url optional
The URL of the resource
GetSoftware_log
Name
action optional
end_time optional
from optional
guid optional
message optional
start_time optional
state optional
to optional
Description The action performed (upgrade/restore) The end time of the upgrade The software version upgrading from The guid of upgrade entry The status message from upgrade The start time of the upgrade The state of the upgrade (succeeded/failed/started The software version upgrading to
GetSoftware_logs
Name
action optional
end_time optional
from optional
guid optional
start_time optional
Description The action performed (upgrade/restore) The end time of the upgrade The software version upgrading from The guid of upgrade entry The start time of the upgrade
Schema boolean boolean string
Schema string string (date-time) string string string string (date-time) string string
Schema string string (date-time) string string string (date-time)
285
Name
state optional
to optional
url optional
Description The state of the upgrade (succeeded/failed/started The software version upgrading to The URL of the resource
Schema string string string
GetSoftware_upgrade
Name
guid optional
upload_date optional
version optional
Description The guid of the software upgrade The upload date of the software upgrade The version of the software upgrade
Schema string string (date-time) string
GetSoftware_upgrades
Name
guid optional
upload_date optional
url optional
version optional
Description The guid of the software upgrade The upload date of the software upgrade The URL of the resource The version of the software upgrade
Schema string string (date-time) string string
GetSound
Name
Description
Schema
created_by optional
The url to the description of the type of this position
string
created_by_id optional
The global id of the user who created this entry
string
guid optional
The global id unique across robots that identifies this sound string
length optional
The length of the sound in the format hh:mm:ss
string
name optional
The name of the sound
string
286
Name
note optional
sound optional
stream optional
volume optional
Description A possible description of the sound A binary representation of the sound The url to stream the raw audio The volumne of the sound when played
Schema string string (byte) string integer
GetSound_stream
Name
guid optional
length optional
name optional
url optional
volume optional
Description
Schema
The global id unique across robots that identifies this sound string
The length of the sound in the format hh:mm:ss
string
The name of the sound
string
The URL of the resource
string
The volumne of the sound when played
integer
GetSounds
Name
guid optional
length optional
name optional
url optional
volume optional
Description
Schema
The global id unique across robots that identifies this sound string
The length of the sound in the format hh:mm:ss
string
The name of the sound
string
The URL of the resource
string
The volumne of the sound when played
integer
GetStatus
287
Name
Description
battery_perce
ntage
The current charge percentage of the battery
optional
battery_time_ remaining optional
The approximate time remaining on the battery during normal operation of the robot
distance_to_ne
xt_target
The distance to the next target of the robot
optional
errors optional
The list of actions executed as part of the mission
footprint optional
The current footprint of the robot
hook_status optional
joystick_low_s peed_mode_en abled optional
joystick_web_s
ession_id
The id of the web user that has control over the joystick
optional
map_id optional
The id of the current map the robot recides in
mission_queu
e_id
The id of the current job the robot executes
optional
mission_queu
e_url
The url to the active mission in queue
optional
mission_text optional
Status message from mission controller
mode_id optional
The id of the current mode of the robot
mode_key_stat
e
A textual description of the position of the mode key
optional
mode_text optional
A textual description of the current state of the robot
moved optional
position optional
Schema number (float) integer number (float) < errors > array string hook_status boolean
string string integer string string integer string string number (float) position
288
Name
Description
robot_model optional
The model of the robot
robot_name optional
The name of the robot
safety_system _muted optional
serial_number optional
The model of the robot
session_id optional
The id of the session the robot recides in
state_id optional
The id of the current state of the robot
state_text optional
A textual description of the current state of the robot
unloaded_ma p_changes optional
uptime optional
The uptime of the robot
user_prompt optional
velocity optional
errors
Name code optional description optional module optional
hook_status
Description The error code Description of the error The module reporting the error
Name
angle optional
available optional
braked optional
Description The current angle of the hook Boolean indicating if the hook available on this robot Boolean indicating if the hook brake is activated
Schema string string boolean string string integer string boolean integer user_prompt velocity
Schema integer string string
Schema number (float) boolean boolean
289
Name
Description
cart optional
cart_attached optional
Boolean indicating if a trolley is currently attached
height optional
The current height of the hook
length optional
The length of the hook
cart
Schema cart boolean number (float) number (float)
Name
Description
Schema
height optional
The height of the attached trolley
number (float)
id optional
The id of the attached trolley
number (float)
length optional
The length of the attached trolley
number (float)
offset_locked_ wheels optional
The distance from front of the attached trolley to the locked wheels
number (float)
width optional
The width of the attached trolley
number (float)
position
Name
orientation optional
x optional
y optional
Description The orientation of the current position of the robot The x-coordinate of the current position of the robot The y-coordinate of the current position of the robot
user_prompt
Schema number (float) number (float) number (float)
Name
guid optional
options optional
question optional
Schema string < string > array string
290
Name timeout optional user_group optional
velocity
Schema number (float) string
Name
angular optional
linear optional
Description The angular speed of the robot in degrees/s The linear speed of the robot in m/s
Schema number (float) number (float)
GetSystem_info
Type : object
GetUser
Name
Description
create_time optional
Creation time of the user
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
dashboard_id optional
email optional
The email of the user
guid optional
The global unique id across robots that identifies this user
name optional
The name of the user
single_dashbo ard optional
update_time optional
Last time the user was updated
url optional
Url to this user
user_group optional
Url for the user group this user is in
Schema string string string string string string string
boolean
string string string
291
Name
Description
user_group_id optional
Global id of the user group this user is in
username optional
The username of the user
GetUser_group
Name
Description
create_time optional
Creation time of the usergroup
created_by optional
The url to the description of the type of this position
created_by_id optional
The global id of the user who created this entry
guid optional
The global unique id across robots that identifies this usergroup
name optional
Name of the usergroup
update_time optional
Last time the usergroup was updated
GetUser_group_permission
Name
Description
endpoint optional
guid optional
The global unique id across robots that identifies this permission
permission_ty
pe
The permission type
optional
url optional
The URL of the resource
GetUser_groups
Name
guid optional
name optional
Description The global unique id across robots that identifies this usergroup
Name of the usergroup
Schema string string
Schema string string string string string string
Schema string string string string
Schema string string
292
Name
url optional
Description The URL of the resource
Schema string
GetUser_me_permissions
Name
Description
endpoint optional
guid optional
The global unique id across robots that identifies this permission
permission_ty
pe
The permission type
optional
url optional
The URL of the resource
Schema string string string string
GetUsers
Name
Description
guid optional
The global unique id across robots that identifies this user
name optional
The name of the user
url optional
The URL of the resource
user_group optional
Url for the user group this user is in
user_group_id optional
Global id of the user group this user is in
Schema string string string string string
GetWifi
Type : object
GetWifi_connection
Name
bssid optional
connected optional
Description Access point mac address Connected to the network of this connection
Schema string boolean
293
Name
Description
device optional
Device to use for this connection
dns optional
Dnss for the connection
ip_address optional
Ip address for the connection
last_connecte d optional
Date and time for when the connection was last successfully connected
mac optional
Network adapter mac address
name optional
Name or id of the connection
netmask optional
Netmask for the connection
security optional
The security method used by the connection
type optional
Connection type e.g. 802-11-wireless
url optional
Specific connection
uuid optional
Uuid of the connection
GetWifi_connections
Name
bssid optional
connected optional
mac optional
name optional
url optional
uuid optional
Description Access point mac address Connected to the network of this connection Network adapter mac address Name or id of the connection The URL of the resource Uuid of the connection
Schema string string string string string string string string string string string
Schema string boolean string string string string
294
GetWifi_network
Name
channel optional
connected optional
device optional
frequency optional
guid optional
security optional
ssid optional
strength optional
url optional
Description Network channel Connected to this network Device Network frequency The guid of the wifi Security Ssid of the wlan Signal strength Specific wifi network
GetWifi_networks
Name
connected optional
guid optional
ssid optional
url optional
Description Connected to this network The guid of the wifi Ssid of the wlan The URL of the resource
GetWorld_model
Type : object
PostAction_definition
Name
parameters required
Schema < object > array
Schema integer boolean string string string string string integer string
Schema boolean string string string
295
PostArea_events
Name
Description
created_by_id optional
guid optional
map_id required
name optional
Max length: 255
note optional
Max length: 255
polygon required
time optional
turn_around optional
type_id required
value required
PostBluetooth_relays
Name
Description
created_by_id optional
guid optional
hardware_id required
name required
Min length: 1, Max length: 255
PostBluetooth_status
Name
module_guid required
Schema string
296
Schema string string string string string < object > array string (date-time) boolean integer (float) number (float)
Schema string string string string
PostCart_calibrations
Name
Description
created_by_id optional
drive_height required
entry_height required
guid optional
lock_height required
name required
Min length: 1, Max length: 40
qw required
qx required
qy required
qz required
standard required
x required
y required
z required
PostCart_types
Name
Description
created_by_id optional
guid optional
height required
length required
Schema string integer (float) integer (float) string integer (float) string number (float) number (float) number (float) number (float) boolean number (float) number (float) number (float)
Schema string string number (float) number (float)
297
Name
Description
name required
Min length: 1, Max length: 40
offset_locked_ wheels required
width required
PostCarts
Name
Description
cart_calibrati on_id required
cart_type_id required
created_by_id optional
guid optional
name required
Min length: 1, Max length: 40
PostDashboard_widgets
Name
dashboard_id required
guid optional
settings optional
Schema string string string
PostDashboards
Name
Description
created_by_id optional
fleet_dashboa rd optional
298
Schema string number (float) number (float)
Schema string string string string string
Schema string boolean
Name
guid optional
name required
Description Min length: 1, Max length: 128
PostDocking_offsets
Name
guid optional
orientation_offset required
pos_id required
x_offset required
y_offset required
Schema string number (float) string number (float) number (float)
PostError_reports
Name
description required
Description Min length: 1, Max length: 255
PostFactory_reset
Name
file optional
Schema string
PostHw_config_import
Name
file required
Schema string
PostIo_module_status
Type : object
Schema string string
Schema string
299
PostIo_modules
Name
Description
address required
created_by_id optional
guid optional
name required
Min length: 1, Max length: 255
num_inputs optional
num_outputs optional
type optional
PostMaps
Name
Description
created_by_id optional
guid optional
map required
metadata required
name required
Min length: 1, Max length: 40
one_way_map optional
origin_theta required
origin_x required
origin_y required
resolution required
session_id required
300
Schema string string string string integer (float) integer (float) string
Schema string string string (byte) string (byte) string string (byte) number (float) number (float) number (float) number (float) string
PostMission_actions
Name
Description
action_type required
Min length: 1, Max length: 255
guid optional
mission_id required
parameters required
priority required
scope_referen ce optional
PostMission_groups
Name
Description
created_by_id optional
feature required
Min length: 1, Max length: 63
guid optional
icon required
name required
Min length: 1, Max length: 63
priority required
PostMission_queues
Name
message optional
mission_id required
parameters optional
Description Max length: 200
Schema string string string < object > array integer (float) string
Schema string string string string (byte) string integer (float)
Schema string string < object > array
301
Name
priority optional
Description
PostMissions
Name
Description
created_by_id optional
description optional
Max length: 255
group_id required
guid optional
hidden optional
name required
Min length: 1, Max length: 255
session_id optional
PostModbus_missions
Name
Description
coil_id required
created_by_id optional
guid optional
mission_id required
name required
Min length: 1, Max length: 200
parameters optional
PostPath_guide_positions
Name
guid optional
Schema string
302
Schema integer (float)
Schema string string string string boolean string string
Schema integer (float) string string string string < object > array
Name
path_guide_guid required
pos_guid required
pos_type required
priority optional
Schema string string string integer (float)
PostPath_guides
Name
Description
created_by_id optional
guid optional
map_id required
name required
Min length: 1, Max length: 128
PostPath_guides_positions
Name
guid optional
path_guide_guid required
pos_guid required
pos_type required
priority optional
Schema string string string string integer (float)
PostPath_guides_precalc
Name
command required
guid required
Schema string string
Schema string string string string
303
PostPaths
Name
Description
autogenerated required
footprint required
Max length: 255
goal_pos_id required
guid optional
last_used required
length required
map_crc required
Min length: 32, Max length: 32
path required
start_pos_id required
time required
valid required
PostPosition_transition_lists
Name
created_by_id optional
goal_pos_id required
guid optional
mission_id required
start_pos_id required
Schema string string string string string
PostPositions
304
Schema boolean string string string string (date-time) number (float) string string (byte) string number (float) boolean
Name
Description
created_by_id optional
guid optional
map_id required
name required
Min length: 1, Max length: 40
orientation required
parent_id optional
pos_x required
pos_y required
type_id required
PostRegister
Name
label optional
value optional
Description Min length: 1, Max length: 50
PostRobots
Name
robots required
Schema < object > array
PostService_books
Name
description required
guid optional
Description Min length: 1, Max length: 2056
Schema string string string string number (float) string number (float) number (float) integer (float)
Schema string number (float)
Schema string string
305
PostSession_import
Name
file required
Schema string
PostSessions
Name
Description
created_by_id optional
description optional
Max length: 255
guid optional
name required
Min length: 1, Max length: 40
PostShelf_types
Name
Description
bar_distance required
bar_length required
created_by_id optional
guid optional
height required
length required
name required
Min length: 1, Max length: 40
offset_x required
offset_y required
width required
306
Schema string string string string
Schema number (float) number (float) string string number (float) number (float) string number (float) number (float) number (float)
PostSounds
Name
Description
created_by_id optional
guid optional
name required
Min length: 1, Max length: 40
note optional
Max length: 255
sound required
volume optional
PostUser_group_permission
Name
Description
endpoint required
Min length: 1, Max length: 255
guid optional
permission_ty pe required
PostUser_groups
Name
Description
created_by_id optional
guid optional
name required
Min length: 2, Max length: 255
PostUsers
Name
Description
created_by_id optional
Schema string string string string string (binary) integer (float)
Schema string string string
Schema string string string
Schema string
307
Name
Description
dashboard_id optional
email optional
guid optional
name required
Min length: 2, Max length: 255
password required
pincode optional
single_dashbo ard optional
user_group_id required
username required
Min length: 2, Max length: 63
PostWifi_connection
Name
address optional
device optional
dns optional
gateway optional
netmask optional
security optional
ssid required
Schema string string string string string string string
PostWifi_connections
308
Schema string string string string string string
boolean
string string
Name
address optional
device optional
dns optional
gateway optional
netmask optional
security optional
ssid required
PostWorld_model
Name
robot_ip optional
world_model optional
PutArea_event
Name
map_id optional
name optional
note optional
polygon optional
time optional
turn_around optional
type_id optional
value optional
Description
Max length: 255 Max length: 255
Schema string string string string string string string
Schema string < object > array
Schema string string string < object > array string (date-time) boolean integer (float) number (float)
309
PutBluetooth_relay
Name
hardware_id optional
name optional
Description Min length: 1, Max length: 255
PutBluetooth_status
Name
on optional
port optional
timeout optional
Schema boolean integer (float) integer (float)
PutCart
Name
Description
cart_calibrati on_id optional
cart_type_id optional
name optional
Min length: 1, Max length: 40
PutCart_calibration
Name
drive_height optional
entry_height optional
lock_height optional
name optional
qw optional
Description Min length: 1, Max length: 40
310
Schema string string
Schema string string string
Schema integer (float) integer (float) integer (float) string number (float)
Name
qx optional
qy optional
qz optional
standard optional
x optional
y optional
z optional
Description
PutCart_type
Name
Description
height optional
length optional
name optional
Min length: 1, Max length: 40
offset_locked_ wheels optional
width optional
PutDashboard
Name
name optional
Description Min length: 1, Max length: 128
PutDashboard_widget
Name
settings optional
Schema string
Schema number (float) number (float) number (float) boolean number (float) number (float) number (float)
Schema number (float) number (float) string number (float) number (float)
Schema string
311
PutDocking_offset
Name
orientation_offset optional
x_offset optional
y_offset optional
Schema number (float) number (float) number (float)
PutHook_brake
Name
state optional
Description Choices are: {0, 1}
PutHook_gripper
Name
state optional
Description Choices are: {0, 1}
PutHook_height
Name
height optional
home optional
Schema integer (float) boolean
PutIo_module
Name
Description
address optional
name optional
Min length: 1, Max length: 255
num_inputs optional
num_outputs optional
312
Schema integer (float)
Schema integer (float)
Schema string string integer (float) integer (float)
Name
type optional
Description Choices are: {"bluetooth", "wise"}
PutIo_module_status
Name
on optional
port optional
timeout optional
Schema boolean integer (float) integer (float)
PutMap
Name
Description
map optional
metadata optional
name optional
Min length: 1, Max length: 40
one_way_map optional
origin_theta optional
origin_x optional
origin_y optional
resolution optional
PutMe
Name
Description
dashboard_id optional
email optional
name optional
Min length: 2, Max length: 255
Schema string
Schema string (byte) string (byte) string string (byte) number (float) number (float) number (float) number (float)
Schema string string string
313
Name
Description
password optional
pincode optional
single_dashbo ard optional
user_group_id optional
username optional
Min length: 2, Max length: 63
PutMission
Name
description optional
group_id optional
hidden optional
name optional
session_id optional
Description Max length: 255
Min length: 1, Max length: 255
PutMission_action
Name
parameters optional
priority optional
scope_reference optional
Schema < object > array integer (float) string
PutMission_group
Name
feature optional
Description Min length: 1, Max length: 63
314
Schema string string boolean string string
Schema string string boolean string string
Schema string
Name
icon optional
name optional
priority optional
Description Min length: 1, Max length: 63
PutMission_queue
Name
cmd optional
description optional
mission_id optional
priority optional
Description Max length: 200
PutModbus_mission
Name
coil_id optional
mission_id optional
name optional
parameters optional
Description Min length: 1, Max length: 200
PutPath
Name
Description
autogenerated optional
footprint optional
Max length: 255
goal_pos_id optional
last_used optional
Schema string (byte) string integer (float)
Schema integer (float) string string integer (float)
Schema integer (float) string string < object > array
Schema boolean string string string (date-time)
315
Name
length optional
map_crc optional
path optional
start_pos_id optional
time optional
valid optional
Description Min length: 32, Max length: 32
PutPath_guide
Name
map_id optional
name optional
Description Min length: 1, Max length: 128
PutPath_guide_position
Name
pos_guid optional
priority optional
Schema string integer (float)
PutPath_guides_position
Name
pos_guid optional
priority optional
Schema string integer (float)
PutPosition
316
Schema number (float) string string (byte) string number (float) boolean
Schema string string
Name
map_id optional
name optional
orientation optional
parent_id optional
pos_x optional
pos_y optional
type_id optional
Description Min length: 1, Max length: 40
PutPosition_transition_list
Name
goal_pos_id optional
mission_id optional
start_pos_id optional
Schema string string string
PutRegister
Name
label optional
value optional
Description Min length: 1, Max length: 50
PutRemote_support
Name
connection_countdown optional
Schema number (float)
PutSession
Schema string string number (float) string number (float) number (float) integer (float)
Schema string number (float)
317
Name
active optional
description optional
name optional
Description
Max length: 255 Min length: 1, Max length: 40
PutSetting
Name
value optional
Description Max length: 700
PutSetting_advanced
Name
value optional
Description Max length: 700
PutShelf_type
Name
bar_distance optional
bar_length optional
height optional
length optional
name optional
offset_x optional
offset_y optional
width optional
Description Min length: 1, Max length: 40
PutSoftware_lock_self
318
Schema boolean string string
Schema string
Schema string
Schema number (float) number (float) number (float) number (float) string number (float) number (float) number (float)
Name
lock optional
Schema boolean
PutSound
Name
name optional
note optional
sound optional
volume optional
Description Min length: 1, Max length: 40 Max length: 255
Schema string string string (binary) integer (float)
PutStatus
Name
Description
Schema
answer optional
Min length: 1, Max length: 255
string
clear_error optional
boolean
datetime optional
string (date-time)
guid optional
string
map_id optional
string
mode_id optional
Choices are: {3, 7}
integer (float)
name optional
Min length: 1, Max length: 20
string
position optional
object
serial_number optional
string
state_id optional
Choices are: {3, 4, 11}, State: {Ready, Pause, Manualcontrol} integer (float)
web_session_i d optional
string
319
PutUser
Name
Description
dashboard_id optional
email optional
name optional
Min length: 2, Max length: 255
password optional
pincode optional
single_dashbo ard optional
user_group_id optional
username optional
Min length: 2, Max length: 63
PutUser_group
Name
name optional
Description Min length: 2, Max length: 255
Schema string string string string string boolean string string
Schema string
320
Asciidoctor PDF 1.5.0.alpha.16, based on Prawn 2.2.2 Asciidoctor PDF 1.5.0.alpha.16, based on Prawn 2.2.2