API —— spatial map の地図情報を更新

このインターフェースは、指定された mapId を使用して地図情報を更新します。HTTP PATCH と同様の更新方式をサポートしており、リクエストで提供されたパラメータのみを変更し、提供されていないパラメータはそのまま維持されます。

1. インターフェース基本情報

インターフェースアドレス: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
リクエストメソッド: PUT
リクエスト形式: multipart/form-data
レスポンス形式: */* (通常は application/json)

2. 認証方式

このインターフェースは以下の2つの認証モードをサポートしています:

トークンベース認証:
- ヘッダー: 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 エラーコード説明

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