Get offerings for a device type

GET 
/api/v2/catalog/offering/device-type/:deviceTypeIdentifier

Retrieves all available component offerings for a specific device type by device type identifier. Optionally filter by platform identifier to narrow down the results.

Request

Path Parameters

deviceTypeIdentifier stringrequired

Device type identifier (ID or name)

Query Parameters

platformIdentifier string

Platform identifier (ID or name)

withDependencies boolean

Indicates whether to include dependencies in the offering

Responses

200

Successfully retrieved device type offering

application/json

Schema

Schema

deviceTypeId doublerequired

ID of the device type

deviceTypeName stringrequired

Name of the device type

projects

object[]

Array [

displayName stringnullable

Display name of the project

label stringnullable

Label of the project

projectId doublerequired

Identifier of the project

projectName stringrequired

Name of the project

release

object

createdAt date-timerequired

dependencies undefined[]

displayName stringnullable

Human-readable display name of the project

id stringrequired

label stringnullable

Label associated with the project

latest booleannullable

metadata

object

autoDeploy booleannullable

Enable automatic deployment of this release

installationSize int64nullable

Installation size in bytes - disk space required after installation (user-specified)

postInstallAction

object

exePath stringnullable

Executable path to run (required when type is EXE)

type Typerequired

Possible values: [NONE, WEB, EXE]

Action type: NONE (no action), WEB (open URL), or EXE (run executable)

url stringnullable

URL to open (required when type is WEB)

totalSize int64nullable

Total size in bytes - automatically calculated as installationSize + artifactsSize

policies

object[]

Policies associated with this release

Array [

association

object

required

releases

object[]

Associated releases for policies

Array [

projectName stringrequired

Project name

version stringrequired

Release version

]

createdAt stringrequired

Policy creation timestamp

description stringnullable

Policy description

id stringrequired

Policy rule ID

isActive booleanrequired

Whether the policy is active

name stringrequired

Policy name

rule objectrequired

The policy rule definition conforming to rule engine schema

type Typerequired

Possible values: [NONE, WEB, EXE]

Action type: NONE (no action), WEB (open URL), or EXE (run executable)

updatedAt stringrequired

Policy last update timestamp

version doublerequired

Policy version number

]

projectId int32required

projectName stringrequired

releaseNotes stringnullable

releasedAt date-time

size int64nullable

status Statusrequired

Possible values: [start, inProgress, done, error, delete, pending]

type Typerequired

Possible values: [NONE, WEB, EXE]

Action type: NONE (no action), WEB (open URL), or EXE (run executable)

updatedAt date-timerequired

version stringrequired

]

Example (from schema)

{
  "deviceTypeId": 0,
  "deviceTypeName": "string",
  "projects": [
    {
      "displayName": "string",
      "label": "string",
      "projectId": 0,
      "projectName": "string",
      "release": {
        "createdAt": "2026-04-22T16:58:12.346Z",
        "dependencies": [
          null
        ],
        "displayName": "string",
        "id": "string",
        "label": "string",
        "latest": true,
        "metadata": {
          "autoDeploy": true,
          "installationSize": 0,
          "postInstallAction": {
            "exePath": "string",
            "type": "NONE",
            "url": "string"
          },
          "totalSize": 0
        },
        "policies": [
          {
            "association": {
              "releases": [
                {
                  "projectName": "string",
                  "version": "string"
                }
              ]
            },
            "createdAt": "string",
            "description": "string",
            "id": "string",
            "isActive": true,
            "name": "string",
            "rule": {},
            "type": "NONE",
            "updatedAt": "string",
            "version": 0
          }
        ],
        "projectId": 0,
        "projectName": "string",
        "releaseNotes": "string",
        "releasedAt": "2026-04-22T16:58:12.346Z",
        "size": 0,
        "status": "start",
        "type": "NONE",
        "updatedAt": "2026-04-22T16:58:12.346Z",
        "version": "string"
      }
    }
  ]
}

404

Device type not found

500

Internal server error

Loading...