Get a relationship type
List details for a relationship type
Authorizations
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Path Parameters
Response
Successfully found relationship type
Response containing relationship type details
Whether cyclical relationships are allowed
false
Defines where a relationship can be configured in entity descriptors
SOURCE, DESTINATION, BOTH "BOTH"
Inheritance configuration for Cortex parameters. Currently supports ownership inheritance via x-cortex-owners.
Whether this relationship type is managed by Cortex
false
Whether an entity can have only one destination for this relationship type
false
Whether an entity can have only one source for this relationship type
false
Human-readable name for the relationship type
"Component Hierarchy"
Unique identifier tag for the relationship type
"component-hierarchy"
Optional description explaining the relationship type
"Defines the component hierarchy"
Plural label for destinations in the relationship
"Parts"
Singular label for destinations in the relationship
"Part"
Plural label for sources in the relationship
"Components"
Singular label for sources in the relationship
"Component"