RelatedInstanceByPathSpecification Interface
A type of RelatedInstanceSpecification that joins related instances by a relationship path.
Extends
Properties
| Name | Type | Description | |
|---|---|---|---|
| relationshipPath | RelationshipPathSpecification | Specifies a chain of relationship path specifications |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| alias Inherited | string | RelatedInstanceSpecificationBase | Specifies an an alias that given to the related instance. |
| isRequired Inherited | boolean | undefined | RelatedInstanceSpecificationBase | Specifies whether to omit the primary instance from the result if the other end of relationshipPath |
Defined in
Last Updated: 24 October, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.