Search documentation
karat

+

K

User Documentation ↗
Version 3.0Beta

Get Marketplace Installation Job Details

GET/api/v3/platform/marketplaceInstallationJobs/{marketplaceInstallationJobRid}/details
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Get available validation results and failure diagnostics for an installation job or draft. Use the installation job's status to track its progress and outcome. These details can help explain why a draft or job has not progressed or completed as expected.

Draft owners receive full validation errors. Other authorized viewers receive a validation summary instead. Failed and aborted jobs return HTTP 200 with their available diagnostics. An explicit abort or a validation-only submission rejection may have no failure diagnostics. The job remains queryable under the same RID after its draft is submitted, subject to retention and access.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:v3:marketplace-installation-job-details:read:get.

Path parameters

marketplaceInstallationJobRid
string

The RID of a Marketplace installation job or its draft.

Query parameters

preview
booleanoptional

Enables the use of preview functionality.

Response body

MarketplaceInstallationJobDetails
object

Available validation and failure diagnostics for an installation job or draft.

Hide child attributes

Hide child attributes

failure
unionoptional

Diagnostics for a draft preparation or submitted-job execution failure, when available. A draft preparation failure can appear alongside validation. Absence does not mean the job succeeded; for example, an explicitly aborted job may have no failure diagnostics. Check the job's status for its outcome.

Show child attributes

Show child attributes

validation
unionoptional

Draft validation results, when available. The draft owner receives the full list of errors; other authorized viewers receive a summary of blocking errors. An empty error list or a summary count of zero is a validation result, not an absence of validation. This field is absent when no draft validation result is available.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v3/platform/marketplaceInstallationJobs/ri.marketplace.main.installation-job.1a80ebf8-341a-4d9e-98e2-9fd4ba7c14d8/details?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 { "validation": { "errors": [ { "severity": "BLOCKING", "target": { "type": "job" }, "errorValue": { "errorCode": "INVALID_ARGUMENT", "errorName": "Marketplace:IncompatibleDefaultBuildOptions", "parameters": { "errorType": { "kind": "installJob" } }, "type": "other" } } ], "type": "errors" }, "failure": { "error": { "errorCode": "INVALID_ARGUMENT", "errorName": "Marketplace:IncompatibleDefaultBuildOptions", "parameters": { "errorType": { "kind": "installJob" } }, "type": "other" }, "type": "draftPreparation" } }

Error responses

Error Name
InstallationInputApiNamesNotEnabledError CodeINVALID_ARGUMENT
Status Code400
DescriptionOne or more installations have product inputs without API names. Enable input API name generation for those products before interacting with them.
ParametersinstallationRids
MarketplaceInstallationJobNotFoundError CodeNOT_FOUND
Status Code404
Description
ParametersmarketplaceInstallationJobRid