Skip to main content

Get offerings for a platform

GET 
/api/v2/catalog/offering/platform/:platformIdentifier

Retrieves all available component offerings for a specific platform by platform identifier. Returns the offering tree including all device types, projects, and components for the platform.

Request​

Path Parameters

    platformIdentifier stringrequired

    Platform identifier (ID or name)

Responses​

Successfully retrieved platform offering

Schema

    deviceTypes

    object[]

  • Array [

    • 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

  • ]

  • ]

    • platformId doublerequired

    ID of the platform

    platformName stringrequired

    Name of the platform

Loading...