Get Blueprint
Retrieves a service blueprint by id.
Request
URI
GET
https://{api_host}/advanced-designer-service/api/tenants/{tenantId}/blueprints/{blueprintId}
COPY
Path Parameters
string
tenantId
Required
The tenant
string
blueprintId
Required
The id of the blueprint to retrieve within the current tenant
Responses
200
successful operation
Returns
ServiceBlueprint
of type(s)
*/*
{
"access": "string",
"builtIn": false,
"description": "string",
"version": {
"major": 0,
"minor": 0,
"micro": 0,
"version": "string",
"revision": 0
},
"component": false,
"name": "string",
"statusName": "string",
"componentConfiguration": {
"scalable": false,
"operations": [
{
"inputParameterName": "string",
"lifecycleType": "string",
"routineId": "string"
}
],
"categoryId": "string"
},
"id": {
"id": "string",
"tenant": "string"
},
"outputParameter": {
"name": "string",
"id": "string",
"resourceType": {
"externalTypeName": "string",
"access": "string",
"reservationTypeId": "string",
"mappingWorkflowId": "string",
"targetCriteria": {},
"builtIn": false,
"externalTypeId": "string",
"description": "string",
"mappingScriptActionFqn": "string",
"version": {
"major": 0,
"minor": 0,
"micro": 0,
"version": "string",
"revision": 0
},
"vcoType": "string",
"listLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{
"value": {}
}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{
"value": {}
}
]
},
"rows": [
{
"items": [
{
"size": 0
}
]
}
]
}
]
}
]
},
"detailsForm": {
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{
"value": {}
}
]
},
"sections": [
{
"designerHidden": false,
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{
"value": {}
}
]
},
"rows": [
{
"items": [
{
"size": 0
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
},
"providerId": "string",
"mappingWorkflow": {
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"outputParameters": [
{
"name": "string",
"type": "string"
}
]
},
"name": "string",
"tenantId": "string",
"id": {
"id": "string",
"tenant": "string"
},
"mappingScriptAction": {
"fqn": "string",
"name": "string",
"description": "string",
"resultContentType": {
"typeId": "string"
},
"inputParameters": [
{
"name": "string",
"type": "string"
}
],
"resultType": "string"
},
"categoryId": "string"
}
},
"workflowId": "string",
"catalogRequestInfoHidden": false,
"forms": [
{
"form": {
"designerLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{
"value": {}
}
]
},
"sections": [
{
"designerHidden": false,
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{
"value": {}
}
]
},
"rows": [
{
"items": [
{
"size": 0
}
]
}
]
}
]
}
]
},
"name": "string"
},
"scenario": {
"usageClass": "string",
"id": "string"
},
"id": "string"
}
],
"status": "string"
}
string
access
Optional
access
boolean
builtIn
Optional
builtIn
string
description
Optional
Constraints:
minLength: 0
maxLength: 2000
description
object
version
Optional
version
boolean
component
Optional
component
string
name
Required
Constraints:
minLength: 1
maxLength: 255
name
string
statusName
Optional
statusName
object
componentConfiguration
Optional
componentConfiguration
object
id
Optional
id
object
outputParameter
Optional
outputParameter
string
workflowId
Required
Constraints:
minLength: 0
maxLength: 255
workflowId
boolean
catalogRequestInfoHidden
Optional
catalogRequestInfoHidden
array of
object
forms
Optional
forms
string
status
Required
status
Possible values are :
DRAFT,
PUBLISHED,
RETIRED,
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/advanced-designer-service/api/tenants/{tenantId}/blueprints/{blueprintId}
Get Operation Operations
GET
Gets the workflow execution data
GET
Searches for ScriptActionSummary objects
GET
Get Blueprint
DELETE
Delete Blueprint
PUT
Update Blueprint
POST
Get the permissible values Of A field In the schema
GET
Retrieves A resource operation
DELETE
Delete Resource Operation
PUT
Update Resource Operation
GET
Gets A ValueDefinition
DELETE
Deletes A ValueDefinition
PUT
Updates Or creates A ValueDefinition
GET
Gets the workflow form
GET
Retrieves the ScriptActionSummary objects underneath A specified category.
GET
Gets A configuration
DELETE
Deletes A configuration
GET
Gets output fields Of A workflow
PUT
Tests default configuration for communication with VRO
PUT
Generates A resource opreation based On A workflow
GET
Retrieves all ScriptActionCategory categories
GET
Gets A form
DELETE
Deletes A form
PUT
Updates A form
POST
Retrieves the values behind the applicable ValueDefinition object for the given key
GET
Gets A workflow
GET
Gets A resource type Or resource mapping
DELETE
Delete Resource Type
POST
Retrieves the value behind the applicable {@link ValueDefinition} for the given key
PUT
Gets A details form
PUT
Tests provided configuration for communication with VRO
GET
Get Tags Of the Catalog Resource Item
GET
Generates A service blueprint based On A workflow
GET
Gets workflow fields
GET
Gets all inventory types matching the filtering criteria
GET
Gets all configurations
PUT
Creates Or updates configuration
GET
Gets workflow subscription By Id
DELETE
Deletes A workflow subscription
PUT
Updates workflow subscription
GET
Gets the count Of active resources