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

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

1. Основная информация API

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

2. Аутентификация

Этот API поддерживает два следующих режима аутентификации:

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

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

3.1 Path Parameters (Path Parameters)

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

3.2 Form Parameters (Form Parameters)

Так как используется формат multipart/form-data, следующие параметры необходимо отправлять как поля формы.

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

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. Коды состояния

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

Коды ошибок Status Code

Описание кодов состояния Sparse Spatial Map 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