FunctionalComponent class

The FunctionalComponent class represents the logical run-time instantiation of a component described in a functional model. It provides a management point for the cloud administrator.

FunctionalComponent class APIs

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

Basic APIs

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

Operation APIs

Name	HTTP method	URI	Description
transferOwnership	`POST`	`csm/FunctionalComponent/guid/transferOwnership`	Transfers the ownership from existing user to the new user

Relationship APIs

Name	HTTP method	URI	Description
relation	`GET`	`csm/FunctionalComponent/guid/destinationFunctionalComponentConnection`	Retrieves the `destinationFunctionalComponentConnection` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/operatingSystem`	Retrieves the `operatingSystem` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/resourceSet`	Retrieves the `resourceSet` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/serviceOfferingInstance`	Retrieves the `serviceOfferingInstance` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/software`	Retrieves the `software` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/sourceFunctionalComponentConnection`	Retrieves the `sourceFunctionalComponentConnection` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/tenant`	Retrieves the `tenant` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/tickets`	Retrieves the `tickets` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/provider`	Retrieves the `provider` relationship.
relation	`GET`	`csm/FunctionalComponent/guid/tags`	Retrieves the `tags` relationship.

FunctionalComponent class relationships and attributes

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

Relationships

Name	Type	Multi- plicity	Description
`destinationFunctionalComponentConnection`	`FunctionalComponentConnection`	0..*	Destination functional component connection
`operatingSystem`	`OperatingSystem`	0..1	Operating system running on the functional component
`resourceSet`	`ResourceSet`	1	Resource set hosted by the functional component
`serviceOfferingInstance`	`ServiceOfferingInstance`	1	Service offering instance associated with the functional component
`software`	`ApplicationSoftware`	0..*	Application software running on the functional component
`sourceFunctionalComponentConnection`	`FunctionalComponentConnection`	0..*	Source functional component connection
`tenant`	`Organization`	1	Tenant for which the functional component is deployed
`tickets`	`Ticket`	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
`functionalModelComponentID`	`String`	1	Identifier of the functional model component for which this is the runtime instantiation
`state`	`ProvisionedResourceState`	1	Current state
`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
`labels`	`String`	0..*
`modifiedDate`	`Date`	0..1	Date the Cloudobject was modified
`name`	`String`	1	Human-readable name of the object