Create a new map

POST 
/maps

The Create Map request allows authenticated users to create a new map in ANSCER ROBOT. This request can only be accessed by users with the appropriate permissions, such as an administrator.

It's important to note that creating a new map into a robot may take some time, depending on the size of the map and the speed of the robot's network connection.

Request

application/json

Body

required

name stringrequired

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

A unique name of the map

Responses

200

User created

application/json

Schema

Schema

_id uuid
name string

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

isActive boolean
properties object
origin object
position objectrequired
x doublerequired
y doublerequired
z doublerequired
orientation objectrequired
x doublerequired
y doublerequired
z doublerequired
w doublerequired
width double
height double
resolution double
previewUrl uri
createdBy object
The user who created this map
_id string
name string
email email
updatedBy object
The user who last updated this map
_id string
name string
email email
createdAt date-time

The date and time this user was created

updatedAt date-time

The date and time this user was last updated

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "isActive": true,
  "properties": {
    "origin": {
      "position": {
        "x": 0,
        "y": 0,
        "z": 0
      },
      "orientation": {
        "x": 0,
        "y": 0,
        "z": 0,
        "w": 0
      }
    },
    "width": 0,
    "height": 0,
    "resolution": 0,
    "previewUrl": "string"
  },
  "createdBy": {
    "_id": "string",
    "name": "string",
    "email": "user@example.com"
  },
  "updatedBy": {
    "_id": "string",
    "name": "string",
    "email": "user@example.com"
  },
  "createdAt": "2024-12-03T13:26:27.408Z",
  "updatedAt": "2024-12-03T13:26:27.408Z"
}

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

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    }
  ]
}

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

The Map with given name already exists.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "The Map with given name already exists."
}

Example

{
  "message": "The Map with given name 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...