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 a registered installation and the product version targeted by its latest submitted job.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:v3:marketplace-installation:read:get.
objectA registered product installation and Compass resource. Its latest target version is absent until an installation job runs.
stringoptionalThe current description of the installation in Compass. Absent if no description is set.
stringThe current display name of the installation in Compass.
objectoptionalThe product version targeted by the latest submitted installation job. This may differ from the currently installed version. Absent if no installation job has run.
stringstringThe RID of the namespace that the installation currently belongs to in Compass.
stringoptionalThe ontology where jobs for this installation create or update ontology resources. Omit if the product does not interact with the ontology.
stringThe RID of the Compass project or folder that currently contains the installation. On creation, this is the destination where the installation is registered and its jobs create resources.
stringstring1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v3/platform/marketplaceInstallations/ri.marketplace.main.block-set-installation.5b2d8f31-6c42-4a7e-9a13-8e0a3e6d9c52?preview=true"1
2
3
4
5
6
7
8
9
{
"rid": "ri.marketplace.main.block-set-installation.5b2d8f31-6c42-4a7e-9a13-8e0a3e6d9c52",
"displayName": "Example Product",
"parentFolderRid": "ri.compass.main.folder.0e77e9f7-683b-4e70-90b5-e35609d37864",
"namespaceRid": "ri.compass.main.namespace.8d34f8ce-1c38-4ff5-8b0e-01aa8d69d28c",
"marketplaceRid": "ri.marketplace.main.local.e74f7e10-08b7-4ed6-aad8-2ffbe901b115",
"productId": "4d9a2e36-52c7-49be-8d10-1fb0cc7481a2",
"ontologyRid": "ri.ontology.main.ontology.c1e96527-1a20-4c7b-b17a-b3c7cfc8f024"
}| Error Name | ||
|---|---|---|
Marketplace | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | ||
| Parameters | marketplaceInstallationRid | |
See Errors for a general overview of errors in the platform.