Table of Contents

API - Delete a Spatial Map

This API is used to permanently delete specified Spatial Map data by mapId.

1. Basic API information

  • API endpoint: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Request method: DELETE
  • Response format: */* (usually application/json)

2. Authentication

This API supports the following two authentication modes:

  1. Token-based authentication:
    • Header: Authorization: [token]
    • Parameter: appId must be included.
  2. Signature-based authentication:
    • Parameters: appId, apiKey, timestamp, and signature must be included.
    • For the detailed signature calculation algorithm, see API Key signature method.

3. Request parameters

3.1 Path parameters

Parameter name Type Required Description
mapId String Yes The unique identifier of the spatial map (MapId).

4. Response data structure (ARMapDTO)

When the request succeeds (statusCode is 0), the returned result contains snapshot information of the deleted map.

Field name Type Description
mapId String Unique map identifier.
name String Map name.
status String Current map status.
size Integer (int64) Map file size.
meta String Custom metadata.
previewUrl String Preview image download link.
emeUrl String EME resource link.
md5 String MD5 checksum of the file.
created DateTime Creation time.
modified DateTime Last modified time.

5. Status codes

Http Code Meaning Description
200 OK Request succeeded, returns the deleted map object.
401 Unauthorized Authentication failed. Check Token or signature.
403 Forbidden No permission to access this resource.

Status Code error codes

6. Example response (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "string",
    "name": "example_map",
    "status": "inactive",
    "size": 1024
  }
}