Create Service Blueprint
Creates service blueprint in the current tenant.
Request
URI
POST
https://{api_host}/advanced-designer-service/api/tenants/{tenantId}/blueprints
COPY
Path Parameters
string
tenantId
Required
The tenant for which the blueprint will be created
Request Body
The blueprint to create
ServiceBlueprint
of type(s)
application/json
Required
Show optional properties
{
"name": "string",
"workflowId": "string",
"status": "string"
}{
"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,
Responses
200
successful operation
Operation doesn't return any data structure
201
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","status:"string","workflowId:"string"}' https://{api_host}/advanced-designer-service/api/tenants/{tenantId}/blueprints
On This Page
Create Operation Operations
POST
Creates An endpoint configuration object
GET
Gets all endpoint configuration objects
POST
Create Resource Type
GET
List Resource Types
POST
Clone Blueprint
POST
Creates A work item
POST
Creates A resource operation
GET
Get Resource Operations
POST
Creates A clone Of A resource operation
POST
Creates A ValueDefinition
GET
Returns A page Of ValueDefinition objects
POST
Creates A workflow subscription
GET
Gets workflow subscriptions matching the filtering criteria
POST
Create Service Blueprint
GET
Get Blueprints
POST
Creates A generic form
GET
Gets all forms matching the filtering criteria