Developer
Documentation
Resources
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Classes
Enumerations
Interfaces
TypeAliases

CompassRelationship

A relationship between two components. The startNode and endNode depends on the direction of the relationship.

Property NameTypeDescription
__typenameLiteral
changeMetadataMaybe<CompassChangeMetadata>
endNodeMaybe<CompassComponent>The ending node of the relationship. This will be the other component if the direction is OUTWARD.
relationshipTypeStringThe type of relationship, e.g DEPENDS_ON or CHILD_OF.
startNodeMaybe<CompassComponent>The starting node of the relationship. This will be the current component if the direction is OUTWARD.
typeMaybe<CompassRelationshipType>The type of relationship.

Rate this page: