Property description
The relationTypes asset creates relations between object types. Once created, the object type relations section specifies what object types use the relation type.
Minimal JSON
{
"key": "",
"name": ""
}“relationTypes”: [ { “key”: “isParentOf”, “name”: “is parent of”, “description”: "", “reverseKey”: “childOf”, “features”: [ { “key”: “is_relation_type_parent_of”, “value”: true } ] ] Example taken from the core package.
Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Unique key of the asset. Used for referencing in the same package or other packages using packageKey#assetKey. | string | Yes |
name | Name of the asset, used as the default EN translation. | string | Yes |
description | Description of the property, displayed as a tooltip. | string | No |
isOriented | Determines whether the relation is not its own reverse relation (e.g., parent of and child of relation types are oriented). | boolean | No |
reverseKey | Key of the reverse relation. Must be specified when isOriented is true. | string | No |
categoryKeys | Keys of the relation type category. | array of strings | No |
features | Array of the relation type’s features. | array | No |
graphLines | Defines how the relation appears in graphs. | array | No |
hasNoReverseRelation | Determines whether relation has no opposite (reverse) relation. Used in Modeling diagrams where one relation can have multiple opposite relations. | boolean | No |
notifications | Array of notifications sent to the user when changes are made. For more information, see Notifications. Keep in mind that not all properties will be applicable for this configuration. | array | No |
translations | Array of translation keys and their definitions that determine how the text is displayed in the UI for the specific asset. For more information, see Translations. | array | No |