Skip to main content

Discover components by context

POST 
/api/v2/device/discover/component

Discovers available components and offerings based on provided discovery context. Returns matching component and software offers filtered by the discovery criteria.

Request​

Body

required

    deviceTypeToken stringnullable

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

    discoveryType DiscoveryTyperequired

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

    general

    object

    metaData nullable

    personalDevice

    object

    idNumber stringnullable
    name stringnullable
    personalNumber stringnullable

    physicalDevice

    object

    ID stringnullabledeprecated
    IP stringnullable
    MAC stringnullable
    OS object
    availableStorage stringnullabledeprecated
    possibleBandwidth stringnullable
    serialNumber stringnullable

    situationalDevice

    object

    availableStorage stringnullable
    bandwidth doublenullable

    location

    object

    alt stringnullable
    lat stringrequired
    long stringrequired
    operativeState booleannullable
    power doublenullable
    time date-time
    weather doublenullable
    id stringrequired

    platform

    object

    devices undefined[]

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

    platformId stringnullable

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

    token stringrequired

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

    snapshotDate stringnullable

    Timestamp when the discovery snapshot was taken

    softwareData

    object

    components

    object[]

  • Array [

    • catalogId stringrequired
    error stringnullable
    state Staterequired

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

  • ]

    • formations string[]nullabledeprecated
    platforms string[]nullabledeprecated

Responses​

Successfully retrieved component offerings

Schema

    offer

    object[]

    required

    deprecated

    Use 'releases' field instead

  • Array [

    • createdAt date-timerequired
    id stringrequired
    latest booleannullable
    metadata nullable
    projectName stringrequired
    releaseNotes stringnullable
    releasedAt date-time
    size int64nullable
    status Statusrequired

    Possible values: [draft, in_review, approved, released, archived]

    type Typerequired

    Possible values: [product, formation]

    updatedAt date-timerequired
    version stringrequired

  • ]

    • push

    object[]

    required

    deprecated

    Use 'releases' field instead

  • Array [

    • createdAt date-timerequired
    id stringrequired
    latest booleannullable
    metadata nullable
    projectName stringrequired
    releaseNotes stringnullable
    releasedAt date-time
    size int64nullable
    status Statusrequired

    Possible values: [draft, in_review, approved, released, archived]

    type Typerequired

    Possible values: [product, formation]

    updatedAt date-timerequired
    version stringrequired

  • ]

    • releases

    object[]

    required

    Components with all additional data of platform and device type hierarchy, project and actions

  • Array [

    • hierarchyTrees

    object[]

    required

    Platform and device type hierarchy where this release is offered

  • Array [

    • deviceTypes

    object[]

    required

    Device types with projects (under platform if platform fields are present, or standalone)

  • Array [

    • deviceTypeId doublenullable

    ID of the device type

    deviceTypeName stringnullable

    Name of the device type

    projectDisplayName stringnullable

    Display name of the project

    projectId doublerequired

    ID of the project

    projectLabel stringnullable

    Label of the project

    projectName stringrequired

    Name of the project

  • ]

    • platformTypeId doublenullable

    Platform Type ID - present when device types are under a platform type

    platformTypeName stringnullable

    Platform Type name - present when device types are under a platform type

  • ]

    • isPush booleanrequired

    Flag indicating if this is a push action

    release

    object

    required

    createdAt date-timerequired
    id stringrequired
    latest booleannullable
    metadata nullable
    projectName stringrequired
    releaseNotes stringnullable
    releasedAt date-time
    size int64nullable
    status Statusrequired

    Possible values: [draft, in_review, approved, released, archived]

    type Typerequired

    Possible values: [product, formation]

    updatedAt date-timerequired
    version stringrequired

  • ]

Loading...