Create a new mission log

POST 
/mission-logs

Create a new mission log.

Request

application/json

Body

required

missionId uuid
robotRequestId uuid
type stringrequired

Possible values: [robotRequest, mission]

Responses

201

Mission log created

application/json

Schema

Schema

_id uuid
missionId uuid
robotRequestId uuid
startedAt date-time
completedAt date-time
status string

Possible values: [pending, active, completed, aborted, cancelled]

completionPercentage number
progress object[]
Array [
state string
startedAt date-time
completedAt date-time
message string
completionPercentage number
]
type string

Possible values: [robotRequest, mission]

createdAt date-time
updatedAt date-time

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "missionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "robotRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "startedAt": "2024-12-03T13:25:44.904Z",
  "completedAt": "2024-12-03T13:25:44.904Z",
  "status": "pending",
  "completionPercentage": 0,
  "progress": [
    {
      "state": "string",
      "startedAt": "2024-12-03T13:25:44.904Z",
      "completedAt": "2024-12-03T13:25:44.904Z",
      "message": "string",
      "completionPercentage": 0
    }
  ],
  "type": "robotRequest",
  "createdAt": "2024-12-03T13:25:44.904Z",
  "updatedAt": "2024-12-03T13:25:44.904Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

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."
}

409

A mission log with the given details already exists.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "A mission log with the given details already exists."
}

Example

{
  "message": "A mission log with the given details already exists."
}

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...