Get Blueprint

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",
            "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": [
                                {}
                            ]
                        },
                        "sections": [
                            {
                                "id": "string",
                                "label": "string",
                                "state": {
                                    "dependencies": [
                                        "string"
                                    ],
                                    "facets": [
                                        {}
                                    ]
                                },
                                "rows": [
                                    {
                                        "items": [
                                            {
                                                "size": 0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            "detailsForm": {
                "form": {
                    "designerLayout": {
                        "pages": [
                            {
                                "id": "string",
                                "label": "string",
                                "state": {
                                    "dependencies": [
                                        "string"
                                    ],
                                    "facets": [
                                        {}
                                    ]
                                },
                                "sections": [
                                    {
                                        "designerHidden": false,
                                        "id": "string",
                                        "label": "string",
                                        "state": {
                                            "dependencies": [
                                                "string"
                                            ],
                                            "facets": [
                                                {}
                                            ]
                                        },
                                        "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": [
                                    {}
                                ]
                            },
                            "sections": [
                                {
                                    "designerHidden": false,
                                    "id": "string",
                                    "label": "string",
                                    "state": {
                                        "dependencies": [
                                            "string"
                                        ],
                                        "facets": [
                                            {}
                                        ]
                                    },
                                    "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

description

version
Optional

version

boolean
component
Optional

component

string
name
Required

name

string
statusName
Optional

statusName

componentConfiguration
Optional

componentConfiguration

id
Optional

id

outputParameter
Optional

outputParameter

string
workflowId
Required

workflowId

boolean
catalogRequestInfoHidden
Optional

catalogRequestInfoHidden

forms
Optional

forms

string
status
Required

status

Possible values are : DRAFT, PUBLISHED, RETIRED,

Get Operation Operations
PUT
Generates A resource opreation based On A workflow
GET
Generates A service blueprint based On A workflow
GET
Get Tags Of the Catalog Resource Item
POST
Get the permissible values Of A field In the schema
GET
Get Blueprint
GET
Get Resource Operations
GET
Gets A configuration
PUT
Gets A details form
GET
Gets A form
GET
Gets A resource type Or resource mapping
GET
Gets A ValueDefinition
GET
Gets A workflow
GET
Gets all configurations
GET
Gets all endpoint configuration objects
GET
Gets all forms matching the filtering criteria
GET
Gets all inventory types matching the filtering criteria
GET
Gets output fields Of A workflow
GET
Gets the count Of active resources
GET
Gets the workflow execution data
GET
Gets the workflow form
GET
Gets workflow fields
GET
Gets workflow subscription By Id
GET
Gets workflow subscriptions matching the filtering criteria
GET
Retrieves A resource operation
GET
Retrieves all ScriptActionCategory categories
GET
Retrieves the ScriptActionSummary objects underneath A specified category.
POST
Retrieves the value behind the applicable {@link ValueDefinition} for the given key
POST
Retrieves the values behind the applicable ValueDefinition object for the given key
GET
Returns A page Of ValueDefinition objects
GET
Searches for ScriptActionSummary objects
PUT
Tests default configuration for communication with VRO
PUT
Tests provided configuration for communication with VRO