ContentRelatedInstances Specification
Returns content for instances related to the selected (input) instances.
Attributes
| Name | Required? | Type | Default | Meaning |
|---|---|---|---|---|
| Filtering | ||||
relationshipPaths |
Yes | RelationshipPathSpecification[] |
List of relationship path specifications to follow when looking for related class instances. | |
instanceFilter |
No | ECExpression | "" |
Condition for filtering instances |
| Ordering | ||||
priority |
No | number |
1000 |
Changes the order of specifications. |
| Content Modifiers | ||||
relatedProperties |
No | RelatedPropertiesSpecification[] |
[] |
Specifications of related properties which are included in the generated content. See this page for more details |
calculatedProperties |
No | CalculatedPropertiesSpecification[] |
[] |
Specifications of calculated properties whose values are generated using provided ECExpressions. See this page for more details |
propertyCategories |
No | PropertyCategorySpecification[] |
[] |
Specifications for custom categories. Simply defining the categories does nothing - they have to be referenced from PropertySpecification defined in propertyOverrides by id. See this page for more details |
propertyOverrides |
No | PropertySpecification[] |
[] |
Specifications for various property overrides. See this page for more details |
showImages |
No | boolean |
false |
Should image IDs be calculated for the returned instances. When true, ImageIdOverride rules get applied when creating content. |
| Misc. | ||||
relatedInstances |
No | RelatedInstanceSpecification[] |
[] |
Specifications of related instances that can be used in content creation. |
Example
{
"specType": "ContentRelatedInstances",
"relationshipPaths": [{
"relationship": { "schemaName": "BisCore", "className": "ModelContainsElements" },
"direction": "Forward",
"targetClass": { "schemaName": "BisCore", "className": "PhysicalElement" }
}],
"arePolymorphic": true
}Last Updated: 21 May, 2020