API —— обновление информации о Spatial Map

Этот интерфейс обновляет информацию о карте по указанному mapId. Поддерживает HTTP PATCH-подход к обновлению, то есть изменяются только параметры, предоставленные в запросе; непредоставленные параметры остаются без изменений.

1. Основная информация об интерфейсе

Адрес интерфейса: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
Метод запроса: PUT
Формат запроса: multipart/form-data
Формат ответа: */* (обычно application/json)

2. Метод аутентификации

Интерфейс поддерживает два режима аутентификации:

Аутентификация на основе токена (Token):
- Заголовок: Authorization: [token]
- Параметр: Требуется AppId.
Аутентификация на основе подписи (Signature):
- Использует APIKey, APISecret, AppId и параметры для генерации подписи и проверки.
- Подробный алгоритм расчета подписи см. в Метод подписи API Key.

3. Параметры запроса

3.1 Параметры пути (Path Parameters)

Имя параметра	Тип	Обязательный	Описание
mapId	String	Да	Уникальный идентификатор пространственной карты (MapId).

3.2 Параметры формы (Form Parameters)

Поскольку используется формат multipart/form-data, следующие параметры передаются через поля формы.

Имя параметра	Тип	Обязательный	Описание
file	File	Нет	Новый файл данных карты.
name	String	Нет	Отображаемое имя карты.
gps	String	Нет	Координаты GPS, связанные с картой (например: "121.4541,31.2221").
tag	String	Нет	Тег карты.
meta	String	Нет	Пользовательские метаданные (обычно строка в кодировке Base64).
clusterInfo	String	Нет	Информация, связанная с кластером.
emeBlocklist	String	Нет	Конфигурация блок-листа EME, по умолчанию "[]".

4. Структура данных ответа (ARMapDTO)

При успешном запросе (statusCode равен 0) результат result будет содержать подробную информацию об обновленном объекте карты.

Имя поля	Тип	Описание
statusCode	Integer	Код состояния. 0 означает успех.
msg	String	Описательное сообщение о состоянии.
timestamp	DateTime	Метка времени ответа сервера.
result	Object	Обновленный объект `ARMapDTO`.

Структура объекта ARMapDTO

Имя поля	Тип	Описание
mapId	String	Уникальный идентификатор карты.
name	String	Название карты.
status	String	Текущее состояние карты.
size	Integer (int64)	Размер файла карты (в байтах).
gps	String	Информация о координатах GPS, связанных с картой.
tag	String	Тег карты.
meta	String	Пользовательские метаданные.
md5	String	MD5-хэш обновленного файла карты.
modified	DateTime	Время последнего изменения.

5. Коды состояния (Status Codes)

HTTP-код	Значение	Описание
200	OK	Запрос успешен.
201	Created	Обновление успешно, связанные записи созданы.
401	Unauthorized	Ошибка аутентификации, проверьте токен или подпись.
403	Forbidden	Нет прав доступа к ресурсу.
404	Not Found	Указанный `mapId` не найден.

Пояснение кодам ошибок Status Code

Пояснение кодам ошибок APIs для разреженных пространственных карт (Sparse Spatial Maps APIs)

6. Пример ответа (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"
  }
}

Table of Contents