Table of Contents

API - Spatial Map を削除する

この API は、mapId によって指定された Spatial Map データを完全に削除するために使用されます。

1. API 基本情報

  • API endpoint: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • request メソッド: DELETE
  • response 形式: */* (通常は application/json)

2. Authentication

この API は次の 2 つの authentication モードをサポートします。

  1. Token ベース authentication:
    • Header: Authorization: [token]
    • Parameter: appId を含める必要があります。
  2. Signature ベース authentication:
    • Parameters: appIdapiKeytimestampsignature を含める必要があります。
    • signature 計算の詳細なアルゴリズムについては、API Key signature method を参照してください。

3. request パラメータ

3.1 Path parameters

パラメータ名 必須 説明
mapId String はい spatial map の一意の識別子 (MapId)。

4. response データ構造 (ARMapDTO)

request が成功した場合 (statusCode が 0)、返される result には削除された map の snapshot information が含まれます。

フィールド名 説明
mapId String map の一意識別子。
name String map 名。
status String map の現在状態。
size Integer (int64) map ファイルサイズ。
meta String カスタム metadata。
previewUrl String preview image ダウンロードリンク。
emeUrl String EME resource リンク。
md5 String ファイルの MD5 checksum。
created DateTime 作成時刻。
modified DateTime 最終変更時刻。

5. Status codes

Http Code 意味 説明
200 OK request 成功。削除された map object を返します。
401 Unauthorized authentication 失敗。Token または signature を確認してください。
403 Forbidden この resource にアクセスする権限がありません。

Status Code error codes

6. response 例 (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "string",
    "name": "example_map",
    "status": "inactive",
    "size": 1024
  }
}