Get Blueprint
Get an existing composite blueprint by its objectId.
Request
URI
GET
https://{api_host}/composition-service/api/blueprints/{id}
COPY
Path Parameters
string
id
Required
The objectId of the blueprint.
Responses
200
Success - return the composite blueprint.
Returns CompositeBlueprint of type(s) */*
{
"catalogItemTypeId": "string",
"description": "string",
"externalId": "string",
"version": 0,
"propertyGroups": [
"string"
],
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"name": "string",
"publishStatusName": "string",
"snapshotVersion": "string",
"id": "string",
"usingCustomForm": false,
"publishStatus": "string"
}object
components
Optional
components
string
catalogItemTypeId
Optional
catalogItemTypeId
string
description
Optional
description
string
externalId
Optional
externalId
integer As int64 As int64
version
Optional
version
array of string
propertyGroups
Optional
propertyGroups
object
layout
Optional
layout
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
tenantId
Optional
tenantId
string
name
Required
name
string
publishStatusName
Optional
publishStatusName
string As uuid As uuid
snapshotVersion
Optional
snapshotVersion
string
id
Optional
id
boolean
usingCustomForm
Optional
usingCustomForm
string
publishStatus
Required
publishStatus
Possible values are : DRAFT, PUBLISHED, RETIRED,
object
properties
Optional
properties
403
Forbidden.
Operation doesn't return any data structure
404
Blueprint not found.
Operation doesn't return any data structure