Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

ServiceOfferingInstance bulkcreate request

Description

This API creates multiple service offering instances.

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 request 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

contractLineID

String

0..*

An array of reconciliation IDs

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 options

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

HTTP response message

Response message headers

This API uses only common response headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.

Was this page helpful? Yes No Submitting... Thank you

Comments