API —— 刪除 Spatial Map 地圖
此介面用於透過 mapId 永久刪除指定的 Spatial Map(空間地圖)資料。
1. 介面基本資訊
- 介面地址:
https://armap-api-<cn1,na1>.easyar.com/map/{mapId} - 請求方法:
DELETE - 響應格式:
*/*(通常為application/json)
2. 認證方式
此介面支援以下兩種鑑權模式:
- 基於 Token 認證:
- Header:
Authorization: [token] - 參數:需附帶
appId。
- Header:
- 基於簽名(Signature)認證:
- 參數:需附帶
appId、apiKey、timestamp、signature。 - 簽名計算的詳細算法,參考API Key 簽名方法。
- 參數:需附帶
3. 請求參數
3.1 路徑參數 (Path Parameters)
| 參數名稱 | 類型 | 是否必選 | 描述 |
|---|---|---|---|
| mapId | String | 是 | 空間地圖的唯一識別碼(MapId)。 |
4. 響應資料結構 (ARMapDTO)
當請求成功(statusCode 為 0)時,返回結果 result 將包含被刪除地圖的快照資訊。
| 欄位名稱 | 類型 | 描述 |
|---|---|---|
| mapId | String | 地圖唯一識別。 |
| name | String | 地圖名稱。 |
| status | String | 地圖目前狀態。 |
| size | Integer (int64) | 地圖檔案大小。 |
| meta | String | 自訂元資料。 |
| previewUrl | String | 預覽圖下載連結。 |
| emeUrl | String | EME 資源連結。 |
| md5 | String | 檔案的 MD5 校驗碼。 |
| created | DateTime | 建立時間。 |
| modified | DateTime | 最後修改時間。 |
5. 狀態碼
| Http Code | 含義 | 說明 |
|---|---|---|
| 200 | OK | 請求成功,返回刪除的地圖物件。 |
| 401 | Unauthorized | 認證失敗,請檢查 Token 或簽名。 |
| 403 | Forbidden | 無權存取該資源。 |
Status Code 錯誤碼
6. 範例響應 (JSON)
{
"statusCode": 0,
"msg": "success",
"timestamp": "2026-01-30T10:00:00Z",
"result": {
"mapId": "string",
"name": "example_map",
"status": "inactive",
"size": 1024
}
}