LogicalHostingEnvironmentBlueprint bulkOnboard request
Description
On-boards a list of LogicalHostingEnvironmentBlueprints from a provider into the CLM database
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/LogicalHostingEnvironmentBlueprint/bulkOnboard | 0..* |
HTTP request message
Query string parameters
This API does not use query string parameters.
Request message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Request message body
This API uses the following objects in the request message body JSON.
Top-level objectsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
Name | Type | Multi- | Description |
|---|---|---|---|
callbackURL | String | 0..1 | URL to call when the operation finishes |
postCallout | String | 0..1 | Identifier of a callout to run after the operation executes |
preCallout | String | 0..1 | Identifier of a callout to run before the operation executes |
timeout | Integer | 0..1 | Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:
|
operationParams | 1 | Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request. |
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
Input parameters to include in operationParamsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
Name | Type | Multi- | Description |
|---|---|---|---|
lheBlueprints | 1..* | A list of LogicalHostingEnvironmentBlueprint objects to be on-boarded. |
HTTP response message
Response message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Response message body
The response message body contains a Task object.
Example
The following example shows an HTTP request that contains the mandatory attributes for the LogicalHostingEnvironmentBlueprint. In this example, the underlying ResourceHostingEnvironmentBlueprint is a ContainerBlueprint because it is an on-premise blueprint:
Host: apiServer.calbro.com:8080
Authentication-Token: AQIC5wM2LY4Sfcx705TK5UqUK6Ythuk1tVWjHMl7/rpY0Ys=@REGUSER123091
{
"operationParams": [
{
"cloudClass" : "com.bmc.cloud.model.beans.LogicalHostingEnvironmentBlueprint",
"externalID" : "276e31e1-f310-488a-99a6-c6698da9145b:VIP Only#0",
"name" : "VIP Only",
"versionNumber" : 0,
"resourceHostingEnvironmentBlueprintObject" :
[
{
"cloudClass" : "com.bmc.cloud.model.beans.ContainerBlueprint",
"externalID" : "276e31e1-f310-488a-99a6-c6698da9145b:VIP Only#0",
"isOnboarded" : false,
"provider" : "/provider/276e31e1-f310-488a-99a6-c6698da9145b",
"version" : "0"
}
]
}
]
}