Get Offering of Device Type

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

This service message allows retrieval of the offering of a specific device type by device token and also optionally specify a specific platform.

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

application/json

Schema

Schema

deviceTypeId numberrequired

ID of the device type

deviceTypeName stringrequired

Name of the device type

projects

object[]

Array [

projectName stringrequired

Name of the project

projectId numberrequired

Identifier of the project

displayName string

Display name of the project

label string

Label of the project

release

object

id stringrequired

version stringrequired

projectName stringrequired

releaseNotes string

metadata

object

autoDeploy boolean

Enable automatic deployment of this release

postInstallAction

object

Post-installation action configuration

type stringrequired

Possible values: [NONE, WEB, EXE]

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

url string

URL to open (required when type is WEB)

exePath string

Executable path to run (required when type is EXE)

installationSize integer

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

totalSize integer

Total size in bytes - automatically calculated as installationSize + artifactsSize

status stringrequired

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

type stringrequired

Possible values: [product, formation]

size int64

createdAt date-timerequired

updatedAt date-timerequired

latest boolean

releasedAt date-time

dependencies undefined[]

policies

object[]

Policies associated with this release

Array [

id stringrequired

Policy rule ID

name stringrequired

Policy name

description string

Policy description

type stringrequired

Possible values: [policy, restriction]

Policy type

association

object

releases

object[]

required

Releases for this policy

Array [

projectId string

Project ID

projectName stringrequired

Project name

version stringrequired

Release version

]

version numberrequired

Policy version number

createdAt stringrequired

Policy creation timestamp

updatedAt stringrequired

Policy last update timestamp

isActive booleanrequired

Whether the policy is active

rule objectrequired

The policy rule definition conforming to rule engine schema

]

]

Example (from schema)

{
  "deviceTypeId": 0,
  "deviceTypeName": "string",
  "projects": [
    {
      "projectName": "string",
      "projectId": 0,
      "displayName": "string",
      "label": "string",
      "release": {
        "id": "string",
        "version": "string",
        "projectName": "string",
        "releaseNotes": "string",
        "metadata": {
          "autoDeploy": true,
          "postInstallAction": {
            "type": "NONE",
            "url": "string",
            "exePath": "string"
          },
          "installationSize": 0,
          "totalSize": 0
        },
        "status": "draft",
        "type": "product",
        "size": 0,
        "createdAt": "2026-03-12T11:20:53.977Z",
        "updatedAt": "2026-03-12T11:20:53.977Z",
        "latest": true,
        "releasedAt": "2026-03-12T11:20:53.977Z",
        "dependencies": [
          null
        ],
        "policies": [
          {
            "id": "string",
            "name": "string",
            "description": "string",
            "type": "policy",
            "association": {
              "releases": [
                {
                  "projectId": "string",
                  "projectName": "string",
                  "version": "string"
                }
              ]
            },
            "version": 0,
            "createdAt": "string",
            "updatedAt": "string",
            "isActive": true,
            "rule": {}
          }
        ]
      }
    }
  ]
}

Loading...