Skip to main content

Get Device Maps

GET 
/api/v1/device/:deviceId/maps

This service message allows retrieval of all registered maps on the given device.

Request​

Path Parameters

    deviceId stringrequired

Responses​

Schema

    id stringrequired
    lastUpdatedDate date-time
    lastConnectionDate date-time
    name string
    OS string
    availableStorage string
    power number
    bandwidth number
    operativeState boolean
    state string

    Possible values: [online, active, offline, disconnected]

    Connectivity state, computed at read-time: online > active > offline > disconnected.

    status string[]

    Possible values: [updating, error, restricted]

    Operational conditions; a device may have several at once (updating/error/restricted).

    online boolean

    True when the device currently holds an open reactive (managed-command) SSE channel.

    metaData object
    groupName string
    groupId number
    uid string
    formations string[]
    platformName string
    platformTypeName string

    The device's platform type name (server-derived from the platform_type catalog).

    deviceTypeName string
    devices string[]
    platformId string

    Platform instance id reported by the agent.

    maps

    object[]

    required

  • Array [

    • map

    object

    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
    state string

    Possible values: [offering, push, import, delivery, deleted, installed, uninstalled]

    error string
    downloadDate date-time
    deployDate date-time

  • ]

Loading...