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 | URI | Description |
|---|---|---|---|
get | GET | Retrieves a FunctionalComponent object. | |
search | POST | Searches for FunctionalComponent objects. |
Operation APIs
Name | HTTP | URI | Description |
|---|---|---|---|
transferOwnership | POST | Transfers the ownership from existing user to the new user |
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the destinationFunctionalComponentConnection relationship. | |
relation | GET | Retrieves the operatingSystem relationship. | |
relation | GET | Retrieves the resourceSet relationship. | |
relation | GET | Retrieves the serviceOfferingInstance relationship. | |
relation | GET | Retrieves the software relationship. | |
relation | GET | Retrieves the sourceFunctionalComponentConnection relationship. | |
relation | GET | Retrieves the tenant relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | 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- | Description |
|---|---|---|---|
destinationFunctionalComponentConnection | 0..* | Destination functional component connection | |
operatingSystem | 0..1 | Operating system running on the functional component | |
resourceSet | 1 | Resource set hosted by the functional component | |
serviceOfferingInstance | 1 | Service offering instance associated with the functional component | |
software | 0..* | Application software running on the functional component | |
sourceFunctionalComponentConnection | 0..* | Source functional component connection | |
tenant | 1 | Tenant for which the functional component is deployed | |
tickets | 0..* |
| |
cloudClass | 1 | Fully-qualified name of the class to which the object belongs | |
provider | 1 | Provider that created the object | |
tags | 0..* | Tags associated with the object |
Attributes
Name | Type | Multi- | Description |
|---|---|---|---|
functionalModelComponentID | String | 1 | Identifier of the functional model component for which this is the runtime instantiation |
state | 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 | 0..1 | Date the Cloudobject was modified | |
name | String | 1 | Human-readable name of the object |