ServiceOfferingInstance class

The ServiceOfferingInstance class represents the instantiation of a particular service offering. It allows for the instantiated service offerings to be tracked and reported upon and acts as a management point for the cloud or customer administrator.

ServiceOfferingInstance class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the ServiceOfferingInstance class.

Basic APIs

Name	HTTP method	URI	Description
get	`GET`	`csm/ServiceOfferingInstance/guid`	Retrieves a `ServiceOfferingInstance` object.
refresh	`POST`	`csm/ServiceOfferingInstance/guid`	Refreshes a `ServiceOfferingInstance` object.
search	`POST`	`csm/ServiceOfferingInstance/search`	Searches for `ServiceOfferingInstance` objects.

Operation APIs

Name	HTTP method	URI	Description
applyOptionChoice	`POST`	`csm/ServiceOfferingInstance/guid/applyOptionChoice`	Applies an option choice to a target.
bulkCreate	`POST`	`csm/ServiceOfferingInstance/bulkCreate`	Creates multiple service offering instances.
bulkEvaluateSensors	`POST`	`csm/ServiceOfferingInstance/bulkEvaluateSensors`	This operation refreshes ops Sensors for all ServiceOfferingInstances passed to it as parameter.
decommission	`POST`	`csm/ServiceOfferingInstance/guid/decommission`	Decommissions the specified service offering instance.
evaluateSensors	`POST`	`csm/ServiceOfferingInstance/guid/evaluateSensors`	This operation refreshes all sensors in the Service Offering Instance. It retrieves SOI CloudObjects. Retrieves Sensor and SensorAttribute instances from CloudObjects for only those SensorAttributes that have SensorAttributeThresholds defined on them. Forms Sensor trees. Invokes Sensor#refreshSensors, passing in the Sensor tree roots to retrieve the Sensor data. Then, SensorAttributeThresholds are evaluated. Then, Policies are evaluated.
offboard	`POST`	`csm/ServiceOfferingInstance/guid/offboard`	Removes a service offering instance.
onboard	`POST`	`csm/ServiceOfferingInstance/onboard`	Creates a service offering instance for an existing virtual machine.
opsDecommission	`POST`	`csm/ServiceOfferingInstance/guid/opsDecommission`	This operation is invoked after service Offering Instance is successfully decommissioned. It will remove Sensors attached to various Service Offering Instance components and notify supporting monitoring provider to stop collecting data for those components.
opsProvision	`POST`	`csm/ServiceOfferingInstance/guid/opsProvision`	This operation is invoked after Service Offering Instance is successfully created. This is a dynamic operation that provisions Sensors for Service Offering Instance components as per Sensor specifications from ops blueprint. Parameters passed are null in case of new Service Offering Instance being provisioned. It operates on the service offering instance on which operation is invoked. In case of new container/component addition to existing Service Offering Instance, ServiceOfferingInstanceSpec will contain only incremental component and related resource Specification CloudObj pair.
share	`POST`	`csm/ServiceOfferingInstance/guid/share`	Refreshes the specified service offering instance.
start	`POST`	`csm/ServiceOfferingInstance/guid/start`	Starts the specified service offering instance.
startCompute	`POST`	`csm/ServiceOfferingInstance/guid/startCompute`	Starts compute on the specified service offering instance.
startSoftwareContainer	`POST`	`csm/ServiceOfferingInstance/guid/startSoftwareContainer`	Start SoftwareContainer(s) which are a part of this SOI.
stop	`POST`	`csm/ServiceOfferingInstance/guid/stop`	Stops the specified service offering instance.
stopCompute	`POST`	`csm/ServiceOfferingInstance/guid/stopCompute`	Stops compute on the specified service offering instance.
stopSoftwareContainer	`POST`	`csm/ServiceOfferingInstance/guid/stopSoftwareContainer`	Stop SoftwareContainer(s) which are a part of this SOI.
transferOwnership	`POST`	`csm/ServiceOfferingInstance/guid/transferOwnership`	Transfers the ownership from existing user to the new user

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/ServiceOfferingInstance/guid/blueprintReference`	Retrieves the `blueprintReference` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/contractLine`	Retrieves the `contractLine` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/deploymentModel`	Retrieves the `deploymentModel` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/deploymentParameterValue`	Retrieves the `deploymentParameterValue` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/functionalComponentConnection`	Retrieves the `functionalComponentConnection` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/functionalComponents`	Retrieves the `functionalComponents` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/functionalModel`	Retrieves the `functionalModel` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/resourceSets`	Retrieves the `resourceSets` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/serviceOfferingContractLine`	Retrieves the `serviceOfferingContractLine` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/tenant`	Retrieves the `tenant` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/users`	Retrieves the `users` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/ServiceOfferingInstance/guid/tags`	Retrieves the `tags` relationship.

ServiceOfferingInstance class relationships and attributes

The following tables list the relationships and attributes of the ServiceOfferingInstance class.

Relationships

Name	Type	Multi- plicity	Description
`blueprintReference`	`BlueprintReference`	0..1
`contractLine`	`ContractLine`	0..1	Contract line referenced by the service offering instance
`deploymentModel`	`DeploymentModel`	1	Deployment model implemented by the service offering instance
`deploymentParameterValue`	`DeploymentParameterValue`	0..*	Associated deployment parameter values
`functionalComponentConnection`	`FunctionalComponentConnection`	0..*	Associated functional component connections
`functionalComponents`	`FunctionalComponent`	1..*	Functional components that make up the service offering instance
`functionalModel`	`FunctionalModel`	1	Functional model implemented by the service offering instance
`resourceSets`	`ResourceSet`	1..*
`serviceOfferingContractLine`	`ServiceOfferingContractLine`	0..1	Associated service offering contract line
`tenant`	`Organization`	1	Tenant for which the service offering instance is deployed
`users`	`User`	0..*
`cloudClass`	`CloudClass`	1	Fully-qualified name of the class to which the object belongs
`provider`	`Provider`	1	Provider that created the object
`tags`	`Tag`	0..*	Tags associated with the object

Attributes

Name	Type	Multi- plicity	Description
`actualDecommissionDate`	`Date`	0..1	Date the service offering instance was decommissioned
`isMonitoringEnabled`	`Boolean`	1
`isMonitoringPoliciesEnabled`	`Boolean`	1
`isOpsEvalEnabled`	`Boolean`	1
`proposedDecommissionDate`	`Date`	0..1	Planned date for decommissioning the service offering instance.
`provisionDate`	`Date`	1	Date the service offering instance was provisioned.
`provisionedDeploymentModel`	`String`	0..1	Provisioned deployment model
`provisionedFunctionalModel`	`String`	0..1	Provisioned functional model
`provisionedServiceOfferingModel`	`String`	0..1
`state`	`ProvisionedResourceState`	1	Current state of the service offering instance
`externalID`	`String`	0..1	Identifier used for the object by an external provider
`owner`	`String`	0..1	Name of the owner of the object
`reconciliationID`	`String`	0..1	Reconciliation identity value for the object from the BMC Atrium CMDB
`tokenID`	`String`	0..1	Token identifier
`description`	`String`	0..1	Text that describes the object
`guid`	`String`	1	Globally unique identifier for the object
`name`	`String`	1	Human-readable name of the object