logo
API docs by Redocly

Fleet API (1.0.0)

Download OpenAPI specification:Download

API Documentation for the LexxFleet service.

maps

Get All Maps

Get information for all maps.

Authorizations:
APIKeyHeader

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Map By Id

Get information for a specified map.

Authorizations:
APIKeyHeader
path Parameters
map_id
required
integer (Map Id)

Id of a map

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "updated": "string",
  • "note": "string",
  • "active": true,
  • "angle": 0
}

Patch Map

Modify a specified map. All parameters are optional.

  • name Display name of the map (String)
  • updated Updated datestamp (in YYYYMMDD format) (String)
  • note For additional information (String)
  • active Indicates map visiblity in the UI (Boolean)
  • angle The angle of the map in the UI (Float)
Authorizations:
APIKeyHeader
path Parameters
map_id
required
integer (Map Id)

Id of a map

Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Updated (string) or Updated (null) (Updated)
Note (string) or Note (null) (Note)
Active (boolean) or Active (null) (Active)
Angle (number) or Angle (null) (Angle)

Responses

Request samples

Content type
application/json
{
  • "name": "kawasaki_lab",
  • "updated": "20240101",
  • "note": "Demo area at kawasaki office.",
  • "active": true,
  • "angle": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "updated": "string",
  • "note": "string",
  • "active": true,
  • "angle": 0
}

robot_emergency_stop

Handle Robots Emergency Stop

Toggle the emergency stop functionality of all robots.

Authorizations:
APIKeyHeader
Request Body schema: application/json
required
enable
required
boolean (Enable)

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Response samples

Content type
application/json
null

Handle Robot Emergency Stop

Toggle the emergency stop functionality of a robot.

Authorizations:
APIKeyHeader
path Parameters
robot_id
required
integer (Robot Id)

Id of a robot

Request Body schema: application/json
required
enable
required
boolean (Enable)

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Response samples

Content type
application/json
null

robots

Get Robots

Get information for all robots.

  • robot_uuid Optional. If provided, will return information for robot with this uuid only
Authorizations:
APIKeyHeader
query Parameters
Robot Uuid (string) or Robot Uuid (null) (Robot Uuid)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Robot By Id

Get information for a robot with the specified ID

Authorizations:
APIKeyHeader
path Parameters
robot_id
required
integer (Robot Id)

ID of a robot

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uuid": "string",
  • "error": true,
  • "error_detail": "string",
  • "error_codes": [
    ],
  • "execute_scenario": "string",
  • "ip_address": "string",
  • "model": "string",
  • "software_version": "string",
  • "serial_number": "string",
  • "connected": true,
  • "remaining_battery": 0,
  • "system_status": "string",
  • "map_id": 0
}

Patch Robot

Modify a specified robot. All parameters are optional.

  • name New display name of the robot (String)
  • map_id ID of the robot's new map (int)
Authorizations:
APIKeyHeader
path Parameters
robot_id
required
integer (Robot Id)

ID of a robot

Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Map Id (integer) or Map Id (null) (Map Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "map_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "uuid": "string",
  • "error": true,
  • "error_detail": "string",
  • "error_codes": [
    ],
  • "execute_scenario": "string",
  • "ip_address": "string",
  • "model": "string",
  • "software_version": "string",
  • "serial_number": "string",
  • "connected": true,
  • "remaining_battery": 0,
  • "system_status": "string",
  • "map_id": 0
}

tasks

Get All Tasks

Get all tasks, filtered by state or robot_id

Authorizations:
APIKeyHeader
query Parameters
state
required
string (TaskStateRequest)
Enum: "running" "reserved" "finished" "cancelled" "error"

state of the task

Robot Id (integer) or Robot Id (null) (Robot Id)

id of a robot

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Task

Creates a new task.

  • scenario_id Integer id of the scenario to be executed
  • robot_id Integer id of a robot (optionally choose a robot to execute the scenario)
  • reservation_time String timestamp of the desired reservation time (optionally set a time for the scenario to be executed)
Authorizations:
APIKeyHeader
Request Body schema: application/json
required
scenario_id
required
integer (Scenario Id) > 0
Robot Id (integer) or Robot Id (null) (Robot Id)
Reservation Time (string) or Reservation Time (null) (Reservation Time)

Responses

Request samples

Content type
application/json
{
  • "scenario_id": 1,
  • "robot_id": null,
  • "reservation_time": "2024-01-01T20:00:00"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "scenario_name": "string",
  • "task_id": 0,
  • "map_id": 0,
  • "robot_id": 0,
  • "start_name": "string",
  • "goal_name": "string",
  • "state": [
    ],
  • "reservation_time": "2019-08-24T14:15:22Z",
  • "starting_time": "2019-08-24T14:15:22Z"
}

Cancel All Tasks

Cancels all tasks in the reserved or running state.

Authorizations:
APIKeyHeader
query Parameters
Robot Id (integer) or Robot Id (null) (Robot Id)

id of a robot (cancel tasks corresponding to this robot)

Responses

Response samples

Content type
application/json
null

Get Task

Get a single task by task uuid.

Authorizations:
APIKeyHeader
path Parameters
task_uuid
required
string (Task Uuid)

uuid of a task

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "scenario_name": "string",
  • "task_id": 0,
  • "map_id": 0,
  • "robot_id": 0,
  • "start_name": "string",
  • "goal_name": "string",
  • "state": [
    ],
  • "reservation_time": "2019-08-24T14:15:22Z",
  • "starting_time": "2019-08-24T14:15:22Z"
}

Update Task

Update a single task by uuid.

  • reservation_time String timestamp for a new reservation time.
Authorizations:
APIKeyHeader
path Parameters
task_uuid
required
string (Task Uuid)

uuid of a task

Request Body schema: application/json
required
reservation_time
required
string (Reservation Time)

Responses

Request samples

Content type
application/json
{
  • "reservation_time": "2024-01-01T20:00:00"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "scenario_name": "string",
  • "task_id": 0,
  • "map_id": 0,
  • "robot_id": 0,
  • "start_name": "string",
  • "goal_name": "string",
  • "state": [
    ],
  • "reservation_time": "2019-08-24T14:15:22Z",
  • "starting_time": "2019-08-24T14:15:22Z"
}

Cancel Task

Cancel a single task by uuid.

Authorizations:
APIKeyHeader
path Parameters
task_uuid
required
string (Task Uuid)

uuid of a task

Responses

Response samples

Content type
application/json
null

scenarios

Get Scenarios

Get all scenarios or use filters to get only the required ones.

  • start_id Optional. If provided, will return scenarios with this start point id
  • destination_id Optional. If provided, will return scenarios with this destination point id
  • map_id Optional. If provided, will return scenarios with this map id
  • name Optional. If provided, will return scenarios with this name
Authorizations:
APIKeyHeader
query Parameters
Start Id (integer) or Start Id (null) (Start Id)
Destination Id (integer) or Destination Id (null) (Destination Id)
Map Id (integer) or Map Id (null) (Map Id)
Name (string) or Name (null) (Name)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Scenario

Get the information for a specified scenario

Authorizations:
APIKeyHeader
path Parameters
scenario_id
required
integer (Scenario Id)

ID of a scenario

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "map_id": 0,
  • "start_id": 0,
  • "destination_id": 0,
  • "content": {
    }
}

health

Liveness Health Check

Check whether an app is responding to requests.

Authorizations:
APIKeyHeader

Responses

Response samples

Content type
application/health+json
{
  • "status": "pass",
  • "output": "string",
  • "description": "string"
}