Get Offering of Project
GET/api/v1/catalog/offering/projects/:projectIdentifier
This service message allows retrieval of the offering of a specific project by project identifier and also optionally specify a specific platform and device-type.
Request
Path Parameters
Project identifier (ID or name)
Query Parameters
Device type identifier (ID or name)
Platform identifier (ID or name)
Indicates whether to include dependencies in the offering
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
]
Array [
Array [
]
]
Name of the project
Identifier of the project
Display name of the project
Label of the project
Application category (user or technician)
Tags of the project
Short one-line summary of the project
releases
object[]
All allowed releases for this project in this hierarchy context
Human-readable display name of the project
Label associated with the project
Application category (user or technician)
Tags of the project
Short one-line summary of the project
metadata
object
Enable automatic deployment of this release
postInstallAction
object
Post-installation action configuration
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
URL to open (required when type is WEB)
Executable path to run (required when type is EXE)
Installation size in bytes - disk space required after installation (user-specified)
Total size in bytes - automatically calculated as installationSize + artifactsSize
Hide this release from agents if the health check URL is not healthy
URL to check for health status. Required when hideIfNotHealthy is true.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
Timeout installation in minutes (user-specified)
deployV2
object
Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.
Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.
Possible values: [v1, v2]
Deploy method the release supports (v2 = install.yaml orchestration). Lets consumers detect it without reading artifacts.
Deploy/V2: the actions the agent exposes for this release (mirrors install.yaml Actions).
Deploy/V2: the supported actions that re-run on every call (default: all except install and uninstall; install.yaml Repeatable overrides).
Possible values: [draft, in_review, approved, released, archived, error]
Possible values: [product, application, lib, bundle, infra, config, config_map]
Possible values: [product, application, lib, bundle, infra, config, config_map]
The actual project type, regardless of agent compatibility
policies
object[]
Policies associated with this release
Policy rule ID
Policy name
Policy description
Possible values: [policy, restriction]
Policy type
association
object
releases
object[]
Associated releases for policies
Project name
Release version
Policy version number
Policy creation timestamp
Policy last update timestamp
Whether the policy is active
Default value: false
Whether this policy should be pushed to agents
The policy rule definition conforming to rule engine schema
Policy IDs associated with this release. Present when deduplicatePolicies flag is set to true.
release
object
Human-readable display name of the project
Label associated with the project
Application category (user or technician)
Tags of the project
Short one-line summary of the project
metadata
object
Component metadata including autoDeploy and postInstallAction configuration. Additional user-defined properties are supported.
Enable automatic deployment of this release
postInstallAction
object
Post-installation action configuration
Possible values: [NONE, WEB, EXE]
Action type: NONE (no action), WEB (open URL), or EXE (run executable)
URL to open (required when type is WEB)
Executable path to run (required when type is EXE)
Installation size in bytes - disk space required after installation (user-specified)
Total size in bytes - automatically calculated as installationSize + artifactsSize
Hide this release from agents if the health check URL is not healthy
URL to check for health status. Required when hideIfNotHealthy is true.
Interval in seconds between health check requests. Required when healthCheckUrl is set.
Timeout installation in minutes (user-specified)
deployV2
object
Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.
Deploy/V2 authored plan (tasks + agent rule). Persisted verbatim for lossless re-edit; the agent consumes the generated install.yaml, not this.
Possible values: [v1, v2]
Deploy method the release supports (v2 = install.yaml orchestration). Lets consumers detect it without reading artifacts.
Deploy/V2: the actions the agent exposes for this release (mirrors install.yaml Actions).
Deploy/V2: the supported actions that re-run on every call (default: all except install and uninstall; install.yaml Repeatable overrides).
Possible values: [draft, in_review, approved, released, archived, error]
Possible values: [product, application, lib, bundle, infra, config, config_map]
Possible values: [product, application, lib, bundle, infra, config, config_map]
The actual project type, regardless of agent compatibility
policies
object[]
Policies associated with this release
Policy rule ID
Policy name
Policy description
Possible values: [policy, restriction]
Policy type
association
object
required
Policy associations (releases, device types, OS types, devices)
releases
object[]
Associated releases for policies
Project name
Release version
Policy version number
Policy creation timestamp
Policy last update timestamp
Whether the policy is active
Default value: false
Whether this policy should be pushed to agents
The policy rule definition conforming to rule engine schema
Policy IDs associated with this release. Present when deduplicatePolicies flag is set to true.
{
"projectName": "string",
"projectId": 0,
"displayName": "string",
"label": "string",
"applicationCategory": "string",
"tags": [
"string"
],
"tagline": "string",
"releases": [
{
"id": "string",
"version": "string",
"projectId": 0,
"projectName": "string",
"displayName": "string",
"label": "string",
"applicationCategory": "string",
"tags": [
"string"
],
"tagline": "string",
"releaseNotes": "string",
"metadata": {
"autoDeploy": true,
"postInstallAction": {
"type": "NONE",
"url": "string",
"exePath": "string"
},
"installationSize": 0,
"totalSize": 0,
"hideIfNotHealthy": true,
"healthCheckUrl": "string",
"healthCheckIntervalSeconds": 0,
"timeoutInstallation": 0,
"deployV2": {},
"deployMethod": "v1",
"supportedActions": [
"string"
],
"repeatableActions": [
"string"
]
},
"status": "draft",
"projectTypeV2": "product",
"size": 0,
"createdAt": "2026-11-08T13:48:42.986Z",
"updatedAt": "2026-11-08T13:48:42.986Z",
"latest": true,
"releasedAt": "2026-11-08T13:48:42.986Z",
"dependencies": [
null
],
"policies": [
{
"id": "string",
"name": "string",
"description": "string",
"type": "policy",
"association": {
"releases": [
{
"projectName": "string",
"version": "string"
}
]
},
"version": 0,
"createdAt": "string",
"updatedAt": "string",
"isActive": true,
"isPush": false,
"rule": {}
}
],
"policyIds": [
"string"
]
}
]
}