RelatedPropertiesSpecification Interface
This specification allows including related instance properties into the content.
see Related properties specification specification reference documentation page
Properties
| Name | Type | Description | |
|---|---|---|---|
| autoExpand | undefined | boolean | Should the field containing related properties be assigned the NestedContentField.autoExpand | |
| forceCreateRelationshipCategory | undefined | boolean | Specifies whether a relationship category should be created regardless of whether any relationship properties were included. | |
| handleTargetClassPolymorphically | undefined | boolean | The attribute tells whether the target class specified through RelatedPropertiesSpecification.propertiesSource should be handled | |
| instanceFilter | undefined | string | Condition for filtering instances targeted by the RelatedPropertiesSpecification.propertiesSource attribute. | |
| nestedRelatedProperties | undefined | RelatedPropertiesSpecification[] | The attribute allows loading additional related properties that are related to the target instance of this specification. | |
| properties | string | PropertySpecification[] | "none" | "*" | List of names or definitions of related class properties that should be included in the content. | |
| propertiesSource | RelationshipPathSpecification | Specifies a chain of relationship path specifications that | |
| relationshipMeaning | "SameInstance" | "RelatedInstance" | The attribute describes what the related properties mean to the primary instance | |
| relationshipProperties | string | PropertySpecification[] | "none" | "*" | List of names or definitions of relationship class properties that should be included in the content. | |
| skipIfDuplicate | undefined | boolean | Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists. | Beta |
Defined in
Last Updated: 20 June, 2023