API —— Update spatial map information

This interface updates map information via the specified mapId. It supports HTTP PATCH-like updates, meaning only parameters provided in the request are modified, while unprovided parameters remain unchanged.

1. Basic interface information

• Interface address: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
• Request method: PUT
• Request format: multipart/form-data
• Response format: */* (typically application/json)

2. Authentication methods

This interface supports two authentication modes:

1. Token-based authentication:
   • Header: Authorization: [token]
   • Parameter: Must include AppId.
2. Signature-based authentication:
   • Uses APIKey, APISecret, and AppId along with parameters to generate a signature for verification.
   • For detailed signature calculation algorithms, refer to API key signature method.

3. Request parameters

3.1 Path parameters

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

3.2 Form parameters

Since the multipart/form-data format is used, the following parameters must be submitted via 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 (e.g., "121.4541,31.2221").
tag	String	No	Map tag.
meta	String	No	Custom metadata (typically a Base64-encoded string).
clusterInfo	String	No	Cluster-related information.
emeBlocklist	String	No	EME blocklist configuration, defaults to "[]".

4. Response data structure (ARMapDTO)

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

Field name	Type	Description
statusCode	Integer	Status code. 0 indicates success.
msg	String	Status description message.
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 status of the map.
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 modification time.

5. Status codes

Http code	Meaning	Description
200	OK	Request succeeded.
201	Created	Update succeeded and related records were created.
401	Unauthorized	Authentication failed. Check token or signature.
403	Forbidden	Access to this resource is forbidden.
404	Not Found	Specified mapId not found.

Status code error codes

• Sparse spatial map APIs error 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"
  }
}