Skip to main content

Discover Catalog

POST 
/api/v1/device/discover

This service message allows a device to post the discovery context for getting offers, software, and maps for the GetApp agent.

Request​

Body

required

    general

    object

    personalDevice

    object

    name string
    idNumber string
    personalNumber string

    situationalDevice

    object

    weather number
    bandwidth number
    time date-time
    operativeState boolean
    power number
    availableStorage string

    location

    object

    lat stringrequired
    long stringrequired
    alt string

    physicalDevice

    object

    MAC string
    IP string
    ID stringdeprecated
    OS string

    Possible values: [android, windows, linux, macos]

    serialNumber string
    possibleBandwidth string
    availableStorage stringdeprecated
    discoveryType stringrequired

    Possible values: [get-app, get-map, mTls]

    softwareData

    object

    formation string

    platform

    object

    name stringrequired

    Name of the platform

    description string

    Description of the platform

    os string

    Possible values: [android, windows, linux, macos]

    Operating system of the platform

    cpuArchitecture string

    Possible values: [X86_64, ARM64]

    cpuCount number

    Number of vCPUs

    memoryMb number

    Memory size in MB

    diskGb number

    Disk size in GB

    diskType string

    Possible values: [HDD, SSD, NVME]

    networkType string

    Possible values: [NAT, BRIDGED, HOST_ONLY, CUSTOM]

    imageId string

    Optional image ID

    metadata object

    Optional tags or metadata

    id numberrequired

    ID of the platform

    createdAt date-timerequired

    Timestamp when the platform was created

    updatedAt date-timerequired

    Timestamp when the platform was last updated

    mapData

    object

    productId string
    productName string
    productVersion string
    productType string
    description string
    boundingBox string
    crs string
    imagingTimeStart string
    imagingTimeEnd string
    creationDate string
    source string
    classification string
    compartmentalization string
    region string
    sensor string
    precisionLevel string
    resolution string
    inventory string[]

Responses​

Schema

    software

    object

    isNewVersion boolean
    platform object

    map

    object

    products

    object[]

  • Array [

    • 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

  • ]

    • configs

    object

    exportMaxResolutionDeg number
    method stringrequired

    Possible values: [single, polygonParts]

    Default value: polygonParts

    status stringrequired

    Possible values: [Success, Error]

    error

    object

    errorCode string

    Possible values: [APP.unknown, DELIVERY.unknown, DELIVERY.notFound, DELIVERY.download, DELIVERY.downloadNotAvailable, DELIVERY.notExist, DELIVERY.invalid, DELIVERY.notVerified, DELIVERY.packageTooLarge, DELIVERY.unableClearCache, PROJECT_MANAGEMENT.unknown, PROJECT_MANAGEMENT.labelNotFound, PROJECT_MANAGEMENT.labelAlreadyExists, PROJECT_MANAGEMENT.labelInUse, MAP.unknown, MAP.notFound, MAP.bBoxIsInvalid, MAP.bBoxNotInAnyPolygon, MAP.getRecordsFailed, MAP.exportMapFailed, MAP.requestInProgress, MAP.areaTooLarge, MAP.areaTooSmall, DEVICE.notFound, DEVICE_TYPE.notFound, DEVICE_TYPE.alreadyExists, DEVICE_PLATFORM.notFound, DEVICE_PLATFORM.alreadyExists, GROUP.notFound, GROUP.notAllowedToAdd, GROUP.orgIdUnknown, GROUP.orgIdNotAllowed, GROUP.orgIdConflict, GROUP.orgIdNotFound]

    APP.unknown: General Error code not listed in the enum
    DELIVERY.unknown: Error code not listed in the enum
    DELIVERY.notFound: No found the delivery with given catalog id
    DELIVERY.download: Download of delivery item failed
    DELIVERY.downloadNotAvailable: Delivery item not yet available for download
    DELIVERY.notExist: The Package not exist in storage
    DELIVERY.invalid: Package of given catalog id is invalid, maybe expired or some else
    DELIVERY.notVerified: Package of given catalog id is not verified, the package can be in valid
    DELIVERY.packageTooLarge: Package of given catalog id is too large, no space in cache
    DELIVERY.unableClearCache: Some issue occurs when trying to clear cache
    PROJECT_MANAGEMENT.unknown: Error code not listed in the enum
    PROJECT_MANAGEMENT.labelNotFound: Label with the given id or name was not found
    PROJECT_MANAGEMENT.labelAlreadyExists: Label with the given name already exists
    PROJECT_MANAGEMENT.labelInUse: Label cannot be deleted as it is being used by projects
    MAP.unknown: Error code not listed in the enum
    MAP.notFound: No found the map with given id
    MAP.bBoxIsInvalid: BBox is probably invalid
    MAP.bBoxNotInAnyPolygon: The given BBox in not contains in any polygon
    MAP.getRecordsFailed: Failed to get records.
    MAP.exportMapFailed: Some error occurs when import map
    MAP.requestInProgress: Delivery was already requested and in processing!
    MAP.areaTooLarge: Area too large to distribute, reduce request size and try again
    MAP.areaTooSmall: Area too small to distribute, increase request size and try again . DEVICE.notFound: Device with given id not found.
    DEVICE_DT_NOT_FOUND: Device type with given id not found.
    DEVICE_DT_ALREADY_EXISTS: Device type with given name already exists.
    DEVICE_PLATFORM.notFound: Platform with given id or name not found.
    DEVICE_PLATFORM_ALREADY_EXISTS: Platform with given name already exists.
    GROUP_NOT_FOUND: Group with the given id was not found.
    GROUP_NOT_ALLOWED_TO_ADD: Not allowed to add to the group, see message for cause.
    GROUP.orgIdUnknown: Organization ID is unknown, see message for cause.
    GROUP.orgIdNotAllowed: Organization ID is not allowed to be used, see message for cause.
    GROUP.orgIdConflict: Organization ID conflict occurred.
    GROUP.orgIdNotFound: Organization ID not found.

    message string
Loading...