RelatedInstanceByTargetInstancesSpecification Interface

A type of RelatedInstanceSpecification that joins related instances by target class and instance IDs.

Extends

Properties

Name Type Description
targetInstances { class: SingleSchemaClassSpecification, instanceIds: string[] } Specifies target class and a list of target ECInstance IDs.  

Inherited properties

Name Type Inherited from Description
alias string RelatedInstanceSpecificationBase Specifies an an alias that given to the related instance.
isRequired undefined | boolean RelatedInstanceSpecificationBase Specifies whether to omit the primary instance from the result if the other end of RelatedInstanceSpecificationBase.relationshipPath

Defined in

Last Updated: 25 April, 2024