Provision

Provision

New request for provisioning network or security components

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

Provisioning request from composition service

compositionProviderRequest of type(s) application/json
Required 
{
    "blueprintRequestId": "string",
    "rootCafeDeploymentId": "string",
    "targetResourceId": "string",
    "rootCafeRequestId": "string",
    "requestType": "string",
    "blueprintName": "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"
    },
    "blueprintId": "string",
    "callbackAdditionalUrlPath": "string"
}
string
blueprintRequestId
Optional

blueprintRequestId

string
rootCafeDeploymentId
Optional

rootCafeDeploymentId

string
targetResourceId
Optional

targetResourceId

string
rootCafeRequestId
Optional

rootCafeRequestId

string
requestType
Optional

requestType

Possible values are : PROVISION, UPDATE, ALLOCATE, DEALLOCATE,
string
blueprintName
Optional

blueprintName

string
requestId
Optional

requestId

string
callbackServiceId
Optional

callbackServiceId

componentRequestInfo
componentInfo
Optional

componentInfo

requestUserContext
userContext
Optional

userContext

string
blueprintId
Optional

blueprintId

string
callbackAdditionalUrlPath
Optional

callbackAdditionalUrlPath

Responses
201

Provisioned request created

Returns ResponseEntity of type(s) */* 
{
    "statusCode": "string"
}
object
headers
Optional

headers

object
body
Optional

body

string
statusCode
Optional

statusCode

Possible values are : CONTINUE, SWITCHING_PROTOCOLS, PROCESSING, CHECKPOINT, OK, CREATED, ACCEPTED, NON_AUTHORITATIVE_INFORMATION, NO_CONTENT, RESET_CONTENT, PARTIAL_CONTENT, MULTI_STATUS, ALREADY_REPORTED, IM_USED, MULTIPLE_CHOICES, MOVED_PERMANENTLY, FOUND, MOVED_TEMPORARILY, SEE_OTHER, NOT_MODIFIED, USE_PROXY, TEMPORARY_REDIRECT, PERMANENT_REDIRECT, BAD_REQUEST, UNAUTHORIZED, PAYMENT_REQUIRED, FORBIDDEN, NOT_FOUND, METHOD_NOT_ALLOWED, NOT_ACCEPTABLE, PROXY_AUTHENTICATION_REQUIRED, REQUEST_TIMEOUT, CONFLICT, GONE, LENGTH_REQUIRED, PRECONDITION_FAILED, PAYLOAD_TOO_LARGE, REQUEST_ENTITY_TOO_LARGE, URI_TOO_LONG, REQUEST_URI_TOO_LONG, UNSUPPORTED_MEDIA_TYPE, REQUESTED_RANGE_NOT_SATISFIABLE, EXPECTATION_FAILED, I_AM_A_TEAPOT, INSUFFICIENT_SPACE_ON_RESOURCE, METHOD_FAILURE, DESTINATION_LOCKED, UNPROCESSABLE_ENTITY, LOCKED, FAILED_DEPENDENCY, UPGRADE_REQUIRED, PRECONDITION_REQUIRED, TOO_MANY_REQUESTS, REQUEST_HEADER_FIELDS_TOO_LARGE, INTERNAL_SERVER_ERROR, NOT_IMPLEMENTED, BAD_GATEWAY, SERVICE_UNAVAILABLE, GATEWAY_TIMEOUT, HTTP_VERSION_NOT_SUPPORTED, VARIANT_ALSO_NEGOTIATES, INSUFFICIENT_STORAGE, LOOP_DETECTED, BANDWIDTH_LIMIT_EXCEEDED, NOT_EXTENDED, NETWORK_AUTHENTICATION_REQUIRED,

On This Page
Network Request Operations
POST
Allocate network Or security component
POST
Create Network Resource
POST
De-allocate network Or security component
POST
Method To Be called By A composition-service To notify the network-service that A previously submitted deployment update request has been completed
POST
Method To Be called By A provider To notify the network service that A previously submitted allocation request has been completed
POST
Method To Be called By A provider To notify the network service that A previously submitted de-allocation request has been completed
POST
Method To Be called By A provider To notify the network service that A previously submitted request has been completed
POST
Provision
POST
Retrieve allocation constraint for network Or security component
POST
Validate Request
POST
Validates A single network Or security component