ServiceOfferingInstance bulkCreate request

Description

This API creates multiple service offering instances. However, if you use this api, service requests (SRM Request) are not created. If you want service requests to be created, you need to use add to cart (2018-03-22_02-56-13_CartView add request) and submit cart (2018-03-22_03-00-48_CartView submit request) APIs.

API stability classification

Committed

API overview

HTTP method	URI	Return type	Return type multiplicity
`POST`	`csm/ServiceOfferingInstance/bulkCreate`	`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- plicity	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: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
`operationParams`	`OperationParameter`	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- plicity	Description
`blueprintConfigurationGuid`	`String`	0..1
`contractLineID`	`String`	0..*	An array of reconciliation IDs. From BMC Cloud Lifecycle Management 3.1.01 onwards, the Platform Manager creates the contract line and do not use the contractLineID passed in the request. This parameter is there for backward compatibility.
`decommissionDate`	`Date`	0..1	Date to decommission the service offering instance
`description`	`String`	0..1	A description of the service offering instance
`hostnamePrefix`	`String`	0..1	Prefix for the host name
`name`	`String`	0..1	Name for the service offering instance
`password`	`String`	0..1	Password for the service offering instance prefixed with the string `plaintext:`. For example: `plaintext:secretWord`
`provisionDate`	`Date`	0..1	Date to provision the service offering instance
`quantity`	`Integer`	1	Number of service offering instances to create
`selectedOptionID`	`String`	0..*	Reconciliation IDs of the selected option choices
`serviceOfferingID`	`ServiceOffering`	1	Reconciliation ID of the service offering
`serviceRequestID`	`String`	0..1	Service request identifier
`tenant`	`String`	0..1	Tenant associated with the service offering instance
`username`	`String`	0..1	User name
`userParameters`	`NameValuePair`	0..*	User parameters
`useWorkingCopy`	`Boolean`	0..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.

Example

The following example shows an HTTP request that creates multiple service offering instances:

POST /csm/serviceofferinginstance/bulkCreate
Host: apiServer.calbro.com:8080
Authentication-Token: AQIC5wM2LY4Sfcx705TK5UqUK6Ythuk1tVWjHMl7/rpY0Ys=@REGUSER123091

{
  "operationParams":[
    {
      "name":"serviceOfferingID",
      "value":{
        "cloudClass":"com.bmc.cloud.model.beans.ServiceOffering",
        "guid":"4b74059b-926f-44bd-bf17-0cbf191d0868",
        "reconciliationID":"OI-f03755df0841461e85b630ed65488362"
      },
      "type":"com.bmc.cloud.model.beans.ServiceOffering",
      "multiplicity":"1"
    },
    {
      "name" : "hostnamePrefix",
      "value" : "api",
      "type" : "java.lang.String",
      "multiplicity" : "0..1"
  	},
	{
      "name":"contractLineID",
      "value":[
        "REGAA5V0GA18EAM5WHK0CKMO6WKII7"
      ],
      "type":"java.lang.String",
      "multiplicity":"1..*"
    },
    {
      "name":"quantity",
      "value":1,
      "type":"java.lang.Integer",
      "multiplicity":"1"
    },
    {
      "name":"selectedOptionID",
      "value":[
        "730C1CA0-E56A-3054-C0BD-DB46DD796B0C",
        "5F8FB35F-27D9-2827-7E81-E16BA5C41D60"
      ],
      "type":"java.lang.String",
      "multiplicity":"0..*"
    },
    {
      "name":"provisionDate",
      "value":1356950557000,
      "type":"java.util.Date",
      "multiplicity":"0..1"
    },
    {
      "name":"tenant",
      "value":"BMC_Provider",
      "type":"java.lang.String",
      "multiplicity":"0..1"
    },
    {
      "name":"serviceRequestID",
      "value":"REQ000000000764",
      "type":"java.lang.String",
      "multiplicity":"0..1"
    },
    {
      "name":"name",
      "value":"EC2_VPC_MT",
      "type":"java.lang.String",
      "multiplicity":"0..1"
    },
    {
      "name":"userParameters",
      "value":[
        {
          "cloudClass":"com.bmc.cloud.model.beans.NameValuePair",
          "guid":"b0382cd8-45c9-4ddd-b475-ddc5b47d47b4",
          "name":"BmcAssignVpcPublicIp",
          "value":"True"
        },
        {
          "cloudClass":"com.bmc.cloud.model.beans.NameValuePair",
          "guid":"2a5690ed-94fd-458e-931b-8d38f355951c",
          "name":"BmcSshInstanceKey",
          "value":"Demo"
        },
        {
          "cloudClass":"com.bmc.cloud.model.beans.NameValuePair",
          "guid":"15f8bb34-68a4-496b-9656-d4c0a30d362f",
          "name":"BmcSecurityGroups",
          "value":"sg-c78a92ab"
        }
      ],
      "type":"com.bmc.cloud.model.beans.NameValuePair",
      "multiplicity":"1..*"
    }
  ],
  "timeout":0,
  "preCallout":"/callout/078ec48f-c68f-4a26-a238-2af244b7e5aa",
  "postCallout":"",
  "callbackURL":"http://pcsm-sqa-r5v12:8090/arsys/plugins/CloudCallBackPlugin/params?server=pcsm-sqa-r5v1&username=csmcallback&pwd=csmcallback",
  "alreadyTraversedGlobalRegistry":false,
  "alreadyTraversedLocalRegistry":false
}

The following example shows an HTTP request that creates a service offering on behalf of another user:

/csm/serviceofferinginstance/bulkCreate
{
 "timeout": -1,
 "preCallout": "",
 "postCallout": "",
 "operationParams":[
 {
 "name":"serviceOfferingID",
 "value":{
 "cloudClass":"com.bmc.cloud.model.beans.ServiceOffering",
 "guid":"OI-a539c5bcebfe412e945e49772774046a",
 "reconciliationID":"9EAC88E0-15E0-C66B-9DB5-801C5F9BA64B"
 },
 "type":"com.bmc.cloud.model.beans.ServiceOffering",
 "multiplicity":"1"
 },
 {
 "name" : "hostnamePrefix",
 "value" : "NSonbehalfTest",
 "type" : "java.lang.String",
 "multiplicity" : "0..1"
 },
 {
 "name":"contractLineID",
 "value":["OI-ceed1f116247447996930abf6432e55a"],
 "type":"java.lang.String",
 "multiplicity":"1..*"
 },
 {
 "name":"quantity",
 "value":1,
 "type":"java.lang.Integer",
 "multiplicity":"1"
 },
 {
 "name":"provisionDate",
 "value":1356950557000,
 "type":"java.util.Date",
 "multiplicity":"0..1"
 },
 {
 "name":"tenant",
 "value":"CloudCore",
 "type":"java.lang.String",
 "multiplicity":"0..1"
 },
 {
 "name":"serviceRequestID",
 "value":"REQ000000000530",
 "type":"java.lang.String",
 "multiplicity":"0..1"
 },
 {
 "name":"name",
 "value":"NS_test_onbehalf",
 "type":"java.lang.String",
 "multiplicity":"0..1"
 }
]
,"onBehalfOfUser" : "clmadmin"
}