getInstanceProps Method

Get the props of a Relationship instance

getInstanceProps<T extends RelationshipProps>(relClassFullName: string, criteria: Id64String | SourceAndTarget): T extends RelationshipProps

throws IModelError if the relationship is not found or cannot be loaded.

see Relationships.tryGetInstanceProps

Parameter Type Description
relClassFullName string The full class name of the relationship in the form of "schema:class"
criteria Id64String | SourceAndTarget Either the relationship instanceId or the source and target Ids

Defined in

Last Updated: 08 January, 2020