Submit Composition Request

Submit Composition Request

Kick off the provisioning of a nested blueprint.

Request
URI
POST
https://{api_host}/composition-service/api/composition/requests
COPY
Request Body

Request data, including blueprint information.

CompositionProviderRequest of type(s) application/json
Required 
{
    "blueprintRequestId": "string",
    "rootCafeRequestId": "string",
    "requestType": "string",
    "blueprintName": "string",
    "blueprintId": "string",
    "cafeResourceId": "string",
    "rootCafeDeploymentId": "string",
    "targetResourceId": "string",
    "targetResourceTypeId": "string",
    "targetResourceProviderId": "string",
    "requestId": "string",
    "callbackServiceId": "string",
    "componentInfo": {
        "resourceId": "string",
        "componentId": "string",
        "componentTypeId": "string",
        "requestInputData": {
            "entries": [
                {
                    "key": "string"
                }
            ]
        },
        "previousComponentData": {
            "entries": [
                {
                    "key": "string"
                }
            ]
        },
        "componentSchema": {
            "fields": [
                {
                    "permissibleValues": {
                        "customAllowed": false
                    },
                    "displayAdvice": "string",
                    "columns": [
                        "Field Object"
                    ],
                    "dataType": {
                        "typeId": "string"
                    },
                    "isMultiValued": false,
                    "description": "string",
                    "orderIndex": 0,
                    "id": "string",
                    "label": "string",
                    "state": {
                        "dependencies": [
                            "string"
                        ],
                        "facets": [
                            {}
                        ]
                    }
                }
            ]
        },
        "componentData": {
            "entries": [
                {
                    "key": "string"
                }
            ]
        }
    },
    "userContext": {
        "requestedFor": "string",
        "requestedBy": "string",
        "reasons": "string",
        "tenantId": "string",
        "subtenantId": "string",
        "description": "string"
    },
    "callbackAdditionalUrlPath": "string"
}
string
blueprintRequestId
Optional

blueprintRequestId

string
rootCafeRequestId
Optional

rootCafeRequestId

string
requestType
Optional

requestType

Possible values are : PROVISION, UPDATE, ALLOCATE, DEALLOCATE, ARCHIVE, CHANGE_LEASE, CHANGE_OWNER, DESTROY, SCALE_IN, SCALE_OUT, RESUME, ALTER_DEPLOYMENT,
string
blueprintName
Optional

blueprintName

string
blueprintId
Optional

blueprintId

string
cafeResourceId
Optional

cafeResourceId

string
rootCafeDeploymentId
Optional

rootCafeDeploymentId

string
targetResourceId
Optional

targetResourceId

string
targetResourceTypeId
Optional

targetResourceTypeId

string
targetResourceProviderId
Optional

targetResourceProviderId

string
requestId
Optional

requestId

string
callbackServiceId
Optional

callbackServiceId

ComponentRequestInfo
componentInfo
Optional

componentInfo

RequestUserContext
userContext
Optional

userContext

string
callbackAdditionalUrlPath
Optional

callbackAdditionalUrlPath

Responses
201

Success - return the location path of the submitted request.

Operation doesn't return any data structure

On This Page
Composition Contract Operations
POST
Submit Composition Request