Spec for one Relationship type.

interface RelationshipTypeSpec {
    allowedRelatedTypes?: string[];
    allowedRelatingTypes?: string[];
    allowSelfReference?: boolean;
    label?: string;
}

Properties

allowedRelatedTypes?: string[]

Allowed types for Relationship.relatedObject. Same matching rules as allowedRelatingTypes.

allowedRelatingTypes?: string[]

Allowed types for Relationship.relatingObject. A type matches when it equals one of these or any of its super-types does. Empty / missing means "any type allowed".

allowSelfReference?: boolean

When false (default), self-references fire RELATIONSHIP_SELF_REFERENCE_FORBIDDEN.

label?: string