SerializedSourceForeignKey

ts

type SerializedSourceForeignKey: object;

Type declaration

HierarchicalFilterConfig?

Experimental

ts

optional HierarchicalFilterConfig: SerializedHierarchicalRelationshipFilterConfig;

Optional configuration for filtering hierarchical relationships.

Id

ts

Id: string;

InwardLabel

ts

InwardLabel: string;

IsBidirectional?

ts

optional IsBidirectional: boolean;

Indicates whether this relationship is bi-directional.
"Related To" is a good example of a bi-directional relationship.

OutwardLabel

ts

OutwardLabel: string;

RelationshipType?

ts

optional RelationshipType: string;

Represents?

ts

optional Represents: string | null;

SourceFields

ts

SourceFields: string[];

TargetFields?

ts

optional TargetFields: string[];

This exists to handle the rare situation when there are fields on the target item that reference the source item.
Please reach out to #dev-data-platform before setting this to a defined value.