Skip to main content

Trigger component discovery

POST 

/api/v2/triggers/discover-component

Triggers discovery of available components and offerings using the agent's current context. Returns matching component and software offers from the GetApp server.

Request

Responses

Successfully retrieved component offerings

Schema

    offer

    object[]

    required

    deprecated

    Use 'releases' field instead

  • Array [

  • 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: [product, formation]

    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: [product, formation]

    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: [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
    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: [product, formation]

    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: [product, formation]

    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: [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 [

  • dependedOnBy string[]nullable

    Array of catalog IDs of releases that directly depend on this release

    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
    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: [product, formation]

    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: [product, formation]

    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: [draft, in_review, approved, released, archived]

    type Typerequired

    Possible values: [product, formation]

    updatedAt date-timerequired
    version stringrequired
  • ]

  • restrictions

    object[]

    required

    List of applicable restrictions for the device based on device ID, device type, OS, and other metadata

  • Array [

  • createdAt stringrequired
    description stringnullable
    id stringrequired
    isActive booleanrequired
    name stringrequired
    rule objectrequired

    The restriction rule object

    type Typerequired

    Possible values: [product, formation]

    updatedAt stringrequired
    version doublerequired
  • ]

Loading...