ServiceOffering create request
Description
This API creates new service offering. Based on the inputs provided, this API also creates CatalogService, RequestableOffering and associates the creates service offering with specified blueprint.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/ServiceOffering/create | void | Not applicable |
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
conditio
Name | Type | Multi- | Description |
|---|---|---|---|
blueprintDocId | String | 0..1 |
|
blueprintId | String | 0..1 |
|
blueprintObjectId | String | 0..1 |
|
catalogServiceName | String | 1 |
|
catalogServiceType | String | 0..1 |
|
changePolicy | String | 0..1 | (Version 4.6.03 and later) |
entitlementPackageIds | String | 0..* |
|
keywords | String | 0..1 | (Version 4.6.03 and later) |
requestableOfferingDescription | String | 0..1 |
|
requestableOfferingName | String | 0..1 |
|
roType | String | 0..1 | (Version 4.6.03 and later) |
serviceOfferingDescription | String | 0..1 |
|
serviceOfferingName | String | 1 |
|
startDate | 0..1 | (Version 4.6.03 and later) |
"operationParams": [
{
"multiplicity": "1",
"name": "catalogServiceName",
"value": "Service-SO"(Service Name),
"type": "java.lang.String"
},
{
"multiplicity": "1",
"name": "catalogServiceType",
"value": "BusinessService",
"type": "java.lang.String"
},
{
"multiplicity": "1",
"name": "serviceOfferingName",
"value": "Service-RO",(Existing or new Service Offering name)
"type": "java.lang.String"
},
{
"multiplicity": "1",
"name": "serviceOfferingDescription",
"value": "API",
"type": "java.lang.String"
},
{
"multiplicity": "1",
"name": "blueprintId",
"value": "38e6fe62-8e4e-480d-8a53-acc4cead9e39",(This is Blueprint guid which can get from Step 5)
"type": "java.lang.String"
},
{
"multiplicity": "1",
"name": "blueprintDocId",
"value": "78a2f5fb-7af4-4f37-8ef3-15faa2791b78",(This is Blueprint document guid which we get from Step 1)
"type": "java.lang.String"
},
{
"multiplicity": "1",
"name": "blueprintObjectId",
"value": "447b90d0-ae03-4156-944f-ad61a6def996",(Definition1 Object which we get from step 3)
"type": "java.lang.String"
},
{
"multiplicity": "1",
"name": "requestableOfferingName",
"value": "Service-RO1",(Name of new Request Offering name it can not be repeated)
"type": "java.lang.String"
},
{
"multiplicity": "1",
"name": "requestableOfferingDescription",
"value": "RO1 Description",
"type": "java.lang.String"
},
{
"multiplicity": "0..*",
"name": "entitlementPackageIds",
"value": [
"SRHAA5V0HC3F9AOBLTS0B6T38ZBZ4F"(Guid of Entitlement Package which we get from stpe 6)
],
"type": "java.lang.String"
}
],
"alreadyTraversedGlobalRegistry": false,
"alreadyTraversedLocalRegistry": false,
"preCallout": "",
"postCallout": "",
"callbackURL": "",
"timeout": 1000000
}
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.