ContentInstancesOfSpecificClasses Specification

Based on ContentInstancesOfSpecificClassesSpecification interface.

Returns content for instances of specific ECClasses.

Attributes

Name Required? Type Default Meaning
Filtering
classes Yes MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[] [] Classes whose instances should be used.
handleInstancesPolymorphically No boolean false Whether to also get content from instances of derived classes.
handlePropertiesPolymorphically No boolean false Whether to also get content from properties of derived classes.
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.
Deprecated
arePolymorphic No boolean false Same as handleInstancesPolymorphically.

Example

{
  "specType": "ContentInstancesOfSpecificClasses",
  "classes": {
    "schemaName": "BisCore",
    "classNames": ["Model"]
  },
  "handleInstancesPolymorphically": true
}

Last Updated: 11 June, 2024