Initiate a mission by ID

POST 
/missions/initiate/:missionId

The Initiate Mission request allows you to initiate a mission. This request takes in the mission's unique ID as a parameter, and will initiate the mission in the Robot.

Request

Path Parameters

missionId stringrequired

The ID of the mission to initiate

application/json

Body

required

iteration integerrequired

The iteration of the mission to initiate

Responses

200

Mission initiated

application/json

Schema

Schema

name stringrequired

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

iteration int32required

Possible values: >= 1

Default value: 1

tasks object[]required
Possible values: >= 1
Array [
anyOf
move
type stringrequired
Possible values: [move]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
waypoint uuidrequired
The ID of the waypoint to move to
label string
Possible values: >= 3 characters and <= 50 characters
charging
type stringrequired
Possible values: [charging]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
hours numberrequired
minutes numberrequired
percentage numberrequired
Possible values: >= 1 and <= 100
ignoreTime booleanrequired
ignorePercentage booleanrequired
label string
Possible values: >= 3 characters and <= 50 characters
conveyor
type stringrequired
Possible values: [conveyor]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
conveyor int32required
label string
Possible values: >= 3 characters and <= 50 characters
turnTable
type stringrequired
Possible values: [turnTable]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
turnTable int32required
label string
Possible values: >= 3 characters and <= 50 characters
manipulator
type stringrequired
Possible values: [manipulator]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
manipulator int32required
label string
Possible values: >= 3 characters and <= 50 characters
lifter
type stringrequired
Possible values: [lifter]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
lifter int32required
label string
Possible values: >= 3 characters and <= 50 characters
waitUser
type stringrequired
Possible values: [waitUser]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
activate booleanrequired
number int32required
label string
Possible values: >= 3 characters and <= 50 characters
docking
type stringrequired
Possible values: [docking]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
dockPoint uuidrequired
The ID of the docking waypoint(Special Waypoint) to dock to
dockMarker int32required
label string
Possible values: >= 3 characters and <= 50 characters
undocking
type stringrequired
Possible values: [undocking]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
dockMarker int32required
label string
Possible values: >= 3 characters and <= 50 characters
multiWaypoint
type stringrequired
Possible values: [multiWaypoint]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
multiWaypoint int32required
label string
Possible values: >= 3 characters and <= 50 characters
qrMarker
type stringrequired
Possible values: [qrMarker]
name string
Possible values: <= 50 characters
id timestamp
data objectrequired
qrMarker int32required
label string
Possible values: >= 3 characters and <= 50 characters
]
map object

_id uuid

name string

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

properties object
createdBy object
The user who created this mission
_id string
name string
email email
updatedBy object
The user who last updated this mission
_id string
name string
email email
createdAt date-time

The date and time this mission was created

updatedAt date-time

The date and time this mission was last updated

Example (from schema)

{
  "name": "string",
  "iteration": 1,
  "tasks": [
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "map": {
    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "properties": {},
  "createdBy": {
    "_id": "string",
    "name": "string",
    "email": "user@example.com"
  },
  "updatedBy": {
    "_id": "string",
    "name": "string",
    "email": "user@example.com"
  },
  "createdAt": "2024-12-03T13:26:27.671Z",
  "updatedAt": "2024-12-03T13:26:27.671Z"
}

400

Robot is not in Auto Mode, to perform this turn Robot to Autonomous mode.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Robot is not in Auto Mode, to perform this turn Robot to Autonomous mode."
}

Example

{
  "message": "Robot is not in Auto Mode, to perform this turn Robot to Autonomous mode."
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

404

Resource not found.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Resource not found."
}

Example

{
  "message": "Resource not found."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...