RequestableOffering create request
Description
This API creates a RequestableOffering object or Post Deploy Action for the required Service Offering.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/RequestableOffering |
|
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 objects
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. |
Input parameters to include in operationParams
Name | Type | Multi- | Description |
|---|---|---|---|
changePolicy | String | 0..1 |
|
entitlementPackages | String | 0..* |
|
isDeliveryRO | Boolean | 0..1 |
|
keywords | String | 0..1 |
|
requestableOfferingDescription | String | 0..1 |
|
requestableOfferingName | String | 1 |
|
roType | String | 0..1 |
|
selectedOptions | String | 0..* |
|
serviceOfferingGuid | String | 1 |
|
startDate | 0..1 |
|
{
"timeout": -1,
"postCallout": "",
"preCallout": "",
"operationParams": [
{
"name": "requestableOfferingName",
"value": "PDAName",(Post Deploy Action Name)
"type": "java.lang.String",
"multiplicity": "1"
},
{
"name": "requestableOfferingDescription",
"value": "Description",(Description of Post Deploy Action)
"type": "java.lang.String",
"multiplicity": "1"
},
{
"name": "isDeliveryRO",
"value": false,
"type": "java.lang.Boolean",
"multiplicity": "1"
},
{
"name": "serviceOfferingGuid",
"value": "eb6703f3-81c1-4ffa-b201-9257172b7ebf",(Service Offering guid which we get from step 8)
"type": "java.lang.String",
"multiplicity": "1"
},
{
"name": "changePolicy",
"value": "No Change Required",
"type": "java.lang.String",
"multiplicity": "1"
},
{
"name": "keywords",
"value": "test",
"type": "java.lang.String",
"multiplicity": "1"
},
{
"name": "roType",
"value": "Compute",
"type": "java.lang.String",
"multiplicity": "1"
},
{
"name": "selectedOptions",
"value": [
" OI-99f0032b30984614b8ffe95b2adbd297"(Guid of Option which we have to map into PDA which get from step 9)
],
"type": "java.lang.String",
"multiplicity": "1..*"
},
{
"name": "entitlementPackages",
"value": [
"SRHAA5V0HC3F9AOBLTS0B6T38ZBZ4F"(Guid of Entitlement Package which we get form step 6)
],
"type": "java.lang.String",
"multiplicity": "1..*"
}
]
}
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.