Get Blueprints By Component Type
Get page of composite blueprint by component type.
Request
URI
GET
https://{api_host}/composition-service/api/blueprints/memberComponentTypes/{componentId}
COPY
Path Parameters
string
componentId
Required
The id of the component type.
Query Parameters
integer
page
Optional
Page Number
integer
limit
Optional
Number of entries per page
string
$orderby
Optional
Multiple comma-separated properties sorted in ascending or descending order
integer
$top
Optional
Sets the number of returned entries from the top of the response (total number per page in relation to skip)
integer
$skip
Optional
Sets how many entries you would like to skip
string
$filter
Optional
Boolean expression for whether a particular entry should be included in the response
Responses
200
Success - return the list of 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",
"customFormStatusName": "string",
"id": "string",
"publishStatus": "string",
"customFormStatus": "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
customFormStatusName
Optional
customFormStatusName
string
id
Optional
id
string
publishStatus
Required
publishStatus
Possible values are :
DRAFT,
PUBLISHED,
RETIRED,
object
properties
Optional
properties
string
customFormStatus
Required
customFormStatus
Possible values are :
NA,
OFF,
ON,
INVALID,
403
Forbidden.
Operation doesn't return any data structure
404
Blueprint not found.
Operation doesn't return any data structure