Skip to main content

Get Inventory Updates (Version 2)

POST 
/api/v2/map/inventory/updates

This service message gets a list of map request IDs and responds if there is new data map-product for them.

Request​

Body

required

    deviceId stringrequired

    inventory

    object

    required

    property name*

    InventoryDetailsDto

    status stringrequired

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

    the state of the device for current device

    src string

    Source of the map for this device — how the device obtained the map (e.g., 'generate', 'shared', 'storage', 'update', 'push').

    footprint string

    The footprint of the map associated with the device.

    name string

    The name of map (generated from file name)

    fileName string

    The name of the file associated with the map.

Responses​

Schema

    updates

    object

    required

    property name*

    InventoryUpdateStatusResDto

    isUpdated booleanrequired

    Indicates whether the map is updated.

    catalogId string

    Catalog ID of the map. a registered catalog ID if the map is unknown.

    updatedMap

    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
Loading...