Discover available components

POST 
/discover/component

Initiates the component discovery process and returns a list of available components (offering).

Request

Responses

200

application/json

Schema

Schema

• Array [

catalogId stringrequired

delivery

object

nullable

artifacts

object[]

required

Array [

arguments stringnullable

artifactType stringnullable

catalogId stringrequired

downloadDuration int32nullable

downloadEta int32nullable

downloadId int32nullable

hash stringnullable

isExecutable booleannullable

itemKey stringrequired

metaData stringnullable

path stringnullable

progress floatrequired

signature stringnullable

size int64required

status DeliveryStatusEnumrequired

Possible values: [Start, InProgress, Done, Pause, Cancel, Error]

url stringrequired

]

catalogId stringrequired

dir stringnullable

downloadDone date-timenullable

error stringnullable

itemType ItemTyperequired

Possible values: [software, map, cache]

progress floatrequired

state DeliveryStaterequired

Possible values: [prepare, download, validation, done]

status DeliveryStatusEnumrequired

Possible values: [Start, InProgress, Done, Pause, Cancel, Error]

deploy

object

nullable

catalogId stringrequired

completedAt date-timenullable

currentTime date-timenullable

deviceId stringrequired

eta int64nullable

messageLog stringnullable

progress int32nullable

requestedStatus DeploymentStatusnullable

Possible values: [Start, Done, Installing, Continue, Pause, Cancelled, Error, Uninstall]

startedAt date-timenullable

status DeploymentStatusnullable

Possible values: [Start, Done, Installing, Continue, Pause, Cancelled, Error, Uninstall]

stoppedAt date-timenullable

type ItemTyperequired

Possible values: [software, map, cache]

displayName stringnullable
latest booleannullable
metadata nullable
name stringrequired

offer

object

nullable

action OfferAction

Possible values: [offer, push]

catalogId stringrequired

deviceId stringrequired

itemType ItemType

Possible values: [software, map, cache]

offeredDate date-time
releaseNotes string
status ComponentState

Possible values: [discovery, offered, delivery, ready, deploy]

uploadDate date-timenullable
versionNumber stringrequired
virtualSize int64

• ]

Example (from schema)

[
  {
    "catalogId": "string",
    "delivery": {
      "artifacts": [
        {
          "arguments": "string",
          "artifactType": "string",
          "catalogId": "string",
          "downloadDuration": 0,
          "downloadEta": 0,
          "downloadId": 0,
          "hash": "string",
          "isExecutable": true,
          "itemKey": "string",
          "metaData": "string",
          "path": "string",
          "progress": 0,
          "signature": "string",
          "size": 0,
          "status": "Start",
          "url": "string"
        }
      ],
      "catalogId": "string",
      "dir": "string",
      "downloadDone": "2026-01-01T11:09:05.934Z",
      "error": "string",
      "itemType": "software",
      "progress": 0,
      "state": "prepare",
      "status": "Start"
    },
    "deploy": {
      "catalogId": "string",
      "completedAt": "2026-01-01T11:09:05.935Z",
      "currentTime": "2026-01-01T11:09:05.935Z",
      "deviceId": "string",
      "eta": 0,
      "messageLog": "string",
      "progress": 0,
      "requestedStatus": "Start",
      "startedAt": "2026-01-01T11:09:05.935Z",
      "status": "Start",
      "stoppedAt": "2026-01-01T11:09:05.935Z",
      "type": "software"
    },
    "displayName": "string",
    "latest": true,
    "name": "string",
    "offer": {
      "action": "offer",
      "catalogId": "string",
      "deviceId": "string",
      "itemType": "software",
      "offeredDate": "2026-01-01T11:09:05.936Z"
    },
    "releaseNotes": "string",
    "status": "discovery",
    "uploadDate": "2026-01-01T11:09:05.936Z",
    "versionNumber": "string",
    "virtualSize": 0
  }
]

500

application/json

Schema

Schema

message stringrequired
name stringrequired
statusCode int32required

Example (from schema)

{
  "message": "string",
  "name": "string",
  "statusCode": 0
}

Loading...