Delete a map by ID

DELETE 
/maps/:mapId

This request is used to delete a map from the ANSCER ROBOT system. Only an admin user is authorized to delete a map. The {mapId} parameter in the endpoint URL specifies the ID of the map that is to be deleted.

Warning: This operation will permanently delete the map and all associated resources such as waypoints, zones, and missions. Use with caution.

Request

Path Parameters

mapId stringrequired

The ID of the map to retrieve, update or delete

Responses

200

Map deleted

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.436Z",
  "updatedAt": "2024-12-03T13:26:27.436Z"
}

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