Get Map by Catalog ID
GET/api/v1/map/map/:catalogId
This service message allows retrieval of a map by catalog ID with all its devices.
Request
Path Parameters
catalogId stringrequired
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
catalogId string
name string
createDate date-time
exportEndDate date-time
boundingBox string
footprint string
size number
area number
status string
Possible values: [Draft, Pending, Start, InProgress, Pause, Cancel, Error, Done, Discovered, Expired, Archived]
fileName string
packageUrl string
imagingStart date-time
imagingEnd date-time
isUpdate boolean
product
object
id stringrequired
Unique identifier for the product (at polygon part method, it the specific polygon part id)
productId stringrequired
Unique identifier for the product
catalogId string
Unique identifier for the product (not the specific polygon part id)
countries string
cities string
resolutionMeter number
productName string
productVersion number
productType string
imagingTimeBeginUTC date-time
imagingTimeEndUTC date-time
maxResolutionDeg number
footprint stringrequired
region string
ingestionDate date-time
devices string[]
{
"catalogId": "string",
"name": "string",
"createDate": "2026-01-01T11:09:06.622Z",
"exportEndDate": "2026-01-01T11:09:06.622Z",
"boundingBox": "string",
"footprint": "string",
"size": 0,
"area": 0,
"status": "Draft",
"fileName": "string",
"packageUrl": "string",
"imagingStart": "2026-01-01T11:09:06.622Z",
"imagingEnd": "2026-01-01T11:09:06.622Z",
"isUpdate": true,
"product": {
"id": "string",
"productId": "string",
"catalogId": "string",
"countries": "string",
"cities": "string",
"resolutionMeter": 0,
"productName": "string",
"productVersion": 0,
"productType": "string",
"imagingTimeBeginUTC": "2026-01-01T11:09:06.622Z",
"imagingTimeEndUTC": "2026-01-01T11:09:06.622Z",
"maxResolutionDeg": 0,
"footprint": "string",
"region": "string",
"ingestionDate": "2026-01-01T11:09:06.622Z"
},
"devices": [
"string"
]
}
Loading...