getInstance Method

Get a Relationship instance

getInstance<T extends Relationship>(relClassSqlName: string, criteria: Id64String | SourceAndTarget): T extends Relationship

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

see Relationships.tryGetInstance

Parameter Type Description
relClassSqlName string  
criteria Id64String | SourceAndTarget Either the relationship instanceId or the source and target Ids

Defined in

Last Updated: 08 January, 2020