API: Update Spatial Map information

This API updates map information through the specified mapId. It supports an update method similar to HTTP PATCH, meaning only parameters provided in the request are modified, and parameters not provided remain unchanged.

1. Basic API information

• Endpoint: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
• Request method: PUT
• Request format: multipart/form-data
• 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:
   • Use APIKey, APISecret, AppId, and parameters to generate a signature for verification.
   • For the detailed signature calculation algorithm, see API Key signature method.

3. Request parameters

3.1 Path parameters (Path Parameters)

Parameter name	Type	Required	Description
mapId	String	Yes	Unique identifier of the Spatial Map (MapId).

3.2 Form parameters (Form Parameters)

Because multipart/form-data is used, the following parameters must be submitted as form fields.

Parameter name	Type	Required	Description
file	File	No	New map data file.
name	String	No	Map display name.
gps	String	No	GPS coordinates associated with the map, for example "121.4541,31.2221".
tag	String	No	Map tag.
meta	String	No	Custom metadata, usually a Base64-encoded string.
clusterInfo	String	No	Cluster-related information.
emeBlocklist	String	No	EME blocklist configuration. The default is "[]".

4. Response data structure (ARMapDTO)

When the request succeeds (statusCode is 0), the returned result contains details of the updated map object.

Field name	Type	Description
statusCode	Integer	Status code. 0 indicates success.
msg	String	Status description.
timestamp	DateTime	Server response timestamp.
result	Object	Updated ARMapDTO object.

ARMapDTO object structure

Field name	Type	Description
mapId	String	Unique map identifier.
name	String	Map name.
status	String	Current map status.
size	Integer (int64)	Map file size in bytes.
gps	String	GPS coordinate information associated with the map.
tag	String	Map tag.
meta	String	Custom metadata.
md5	String	MD5 checksum of the updated map file.
modified	DateTime	Last modified time.

5. Status codes

Http Code	Meaning	Notes
200	OK	Request succeeded.
201	Created	Update succeeded and the related record was created.
401	Unauthorized	Authentication failed. Check the Token or signature.
403	Forbidden	No permission to access this resource.
404	Not Found	The specified mapId was not found.

Status Code error codes

• Sparse Spatial Map APIs status code description

6. Example response (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
    "name": "updated_office_scene",
    "status": "active",
    "gps": "121.4541,31.2221",
    "modified": "2026-01-30T10:00:00Z"
  }
}