FunctionalModel class
The FunctionalModel class represents the software components and the connections between them necessary to implement the functionality described in a service offering.
FunctionalModel class APIs
The following tables list the basic APIs, operation APIs, and relationship APIs for the FunctionalModel class.
Basic APIs
Name | HTTP | URI | Description |
|---|---|---|---|
get | GET | Retrieves a FunctionalModel object. | |
search | POST | Searches for FunctionalModel objects. |
Operation APIs
The FunctionalModel class has no operation APIs.
Relationship APIs
Name | HTTP | URI | Description |
|---|---|---|---|
relation | GET | Retrieves the blueprint relationship. | |
relation | GET | Retrieves the deploymentModel relationship. | |
relation | GET | Retrieves the serviceOfferings relationship. | |
relation | GET | Retrieves the tickets relationship. | |
relation | GET | Retrieves the provider relationship. | |
relation | GET | Retrieves the tags relationship. |
FunctionalModel class relationships and attributes
The following tables list the relationships and attributes of the FunctionalModel class.
Relationships
Name | Type | Multi- | Description |
|---|---|---|---|
blueprint | 1 |
| |
deploymentModel | 0..* | Deployment models associated with the functional model | |
serviceOfferings | 0..* | Service offerings referenced by the functional model | |
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 |
|---|---|---|---|
endDate | 0..1 | The date the model stopped being or will stop being effective. | |
modelDocument | String | 1 | Model document |
startDate | 0..1 | The date the model became or will become effective | |
state | String | 0..1 | Current state of the model. For example, "Draft" or "Approved" |
isOnboarded | Boolean | 1 | Indicates whether the object is onboarded |
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 |