Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

FunctionalComponentConnection class


The FunctionalComponentConnection class represents the instantiation of a connection described in a FunctionalModel.

FunctionalComponentConnection class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

create

POST

Creates a FunctionalComponentConnection object.

delete

DELETE

Deletes a FunctionalComponentConnection object.

get

GET

Retrieves a FunctionalComponentConnection object.

update

POST

Updates a FunctionalComponentConnection object.

search

POST

Searches for FunctionalComponentConnection objects.

Operation APIs

The FunctionalComponentConnection class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

Retrieves the destinationFunctionalComponent relationship.

relation

GET

Retrieves the logicalCommunicationPath relationship.

relation

GET

Retrieves the serviceOfferingInstance relationship.

relation

GET

Retrieves the sourceFunctionalComponent relationship.

relation

GET

Retrieves the tickets relationship.

relation

GET

Retrieves the provider relationship.

relation

GET

Retrieves the tags relationship.

FunctionalComponentConnection class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

destinationFunctionalComponent

1

Destination functional component connection

logicalCommunicationPath

0..1

Logical communication path that realizes the functional component connection

serviceOfferingInstance

1

Associated service offering instance

sourceFunctionalComponent

1

Source functional component connection

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-
plicity

Description

destinationPort
Integer

0..1

Destination port

direction
String

0..1

Direction of the functional component connection

sourcePort
Integer

0..1

Source port

transportProtocol
Integer

0..1

The protocol used in this communication.

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

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*