Discover Device Context

POST 
/api/v1/device/discover/deviceContext

This service message allows a device to post the discovery context.

Request

application/json

Body

required

id stringrequired
snapshotDate string

Timestamp when the discovery snapshot was taken

deviceTypeToken string

Name or ID (as string) of the deviceType (e.g., router, switch, server, etc.), used for discovery of devices of type "device"

platform

object

token stringrequired

Name or ID (as string) of the platform type being discovered.

platformId string

ID (as string) of system or machine being discovered.

devices array

Array of devices discovered within this platform. Each device contains detailed discovery information of type "DiscoveryMessageV2Dto".

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

metaData object
discoveryType stringrequired

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

softwareData

object

formations string[]deprecated

platforms string[]deprecated

components

object[]

Array [

catalogId stringrequired

state stringrequired

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

error string

]

supportedFields

object[]

List of fields that the device supports for evaluation, including their types (e.g., number, string, boolean)

Array [

name stringrequired

Field name in JSONPath format (e.g., $.battery.level)

type stringrequired

Field data type (number, string, boolean)

label string

Human-readable label for the field

description string

Field description

]

Responses

200

application/json

Schema

Schema

id stringrequired
snapshotDate string

Timestamp when the discovery snapshot was taken

deviceTypeToken string

Name or ID (as string) of the deviceType (e.g., router, switch, server, etc.), used for discovery of devices of type "device"

platform

object

token stringrequired

Name or ID (as string) of the platform type being discovered.

platformId string

ID (as string) of system or machine being discovered.

devices array

Array of devices discovered within this platform. Each device contains detailed discovery information of type "DiscoveryMessageV2Dto".

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

metaData object
discoveryType stringrequired

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

softwareData

object

formations string[]deprecated

platforms string[]deprecated

components

object[]

Array [

catalogId stringrequired

state stringrequired

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

error string

]

supportedFields

object[]

List of fields that the device supports for evaluation, including their types (e.g., number, string, boolean)

Array [

name stringrequired

Field name in JSONPath format (e.g., $.battery.level)

type stringrequired

Field data type (number, string, boolean)

label string

Human-readable label for the field

description string

Field description

]

Example (from schema)

{
  "id": "string",
  "snapshotDate": "string",
  "deviceTypeToken": "string",
  "platform": {
    "token": "string",
    "platformId": "string",
    "devices": [
      null
    ]
  },
  "general": {
    "personalDevice": {
      "name": "string",
      "idNumber": "string",
      "personalNumber": "string"
    },
    "situationalDevice": {
      "weather": 0,
      "bandwidth": 0,
      "time": "2026-03-12T11:20:54.102Z",
      "operativeState": true,
      "power": 0,
      "availableStorage": "string",
      "location": {
        "lat": "string",
        "long": "string",
        "alt": "string"
      }
    },
    "physicalDevice": {
      "MAC": "string",
      "IP": "string",
      "OS": "android",
      "serialNumber": "string",
      "possibleBandwidth": "string"
    },
    "metaData": {}
  },
  "discoveryType": "get-app",
  "softwareData": {
    "components": [
      {
        "catalogId": "string",
        "state": "offering",
        "error": "string"
      }
    ]
  },
  "supportedFields": [
    {
      "name": "string",
      "type": "string",
      "label": "string",
      "description": "string"
    }
  ]
}

Loading...