ServiceOfferingInstance share request

Description

This API shares the service offering instance specified by the identifier in the URI with the specified users. These users can then perform any action on the service offering instance and resources in it. However, the ownership of the instance and resources remains with the original owner. If you want to transfer ownership, you should use the ServiceOfferingInstance-transferOwnership-request or the ServiceOfferingInstance transferOwnershipAndShare request API.

API stability classification

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/ServiceOfferingInstance/guid/share	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
userNameList	String	0..*	Actual login IDs/user names with which the service needs to be shared

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 shares an SOI. Ensure that the value for the user name is the actual LoginID, for example clmadmin.

csm/ServiceOfferingInstance/6f2857e6-cb29-4c9e-9cca-fa5d75b8ba6c
/share
{
    "timeout": 0,
    "preCallout": "",
    "postCallout": "",
    "callbackURL" : "",
    "operationParams":[
    {
      "name" :"userNameList",
      "value" :["clmadmin"],
      "type" :"java.lang.String",
      "multiplicity" :"0..*"
    },
]
}