Table of Contents

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 は次の 2 つの認証モードをサポートします。

  1. Token ベース認証:
    • Header: Authorization: [token]
    • Parameter: AppId を付加する必要があります。
  2. Signature ベース認証:
    • APIKeyAPISecretAppId とパラメータを使用して signature を生成し、検証します。
    • signature 計算の詳細なアルゴリズムについては、API Key 署名方法を参照してください。

3. リクエストパラメータ

3.1 パスパラメータ (Path Parameters)

パラメータ名 必須 説明
mapId String はい Spatial Map の一意識別子(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 いいえ 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 エラーコード

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"
  }
}