Property description
The features property defines relation types and their behaviour, as well as how they are displayed.
Minimal JSON
{
"key": ""
}“relationTypes”: [ { “key”: “isParentOf”, …, “features”: [ { “key”: “is_relation_type_parent_of”, “value”: true } ] ] Example taken from the core package.
Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Feature key. | string* | Yes |
value | String value of the feature. Mostly used default value. | string | No |
*Supported key values
| Name | Is Single Only* | Data Type | Usage |
|---|---|---|---|
can_be_shown_in_diagram | No | boolean | Allows the relation to be shown in diagrams. |
disable_excel_object_export | No | boolean | Excludes the relation type from Excel object export. |
disable_excel_template_export | No | boolean | Excludes the relation type from the Excel export template. |
force_comment | No | boolean | Providing a comment is mandatory when the relation type is created or removed. |
fullness_score_value | No | double | Sets the weight (importance) for adding the relation type between two objects to calculate the fullness score. |
has_copy | Yes | boolean | The relation is created when objects from space/app 1 are copied to space/app 2. Target object is the original object. Opposite relation to is_copy_of. |
include_in_ai_summary | No | boolean | Uses the relation type in the content of an AI-generated summary. |
is_copy_of | Yes | boolean | The relation is created when objects from space/app 1 are copied to space/app 2. Target object is the copy. Opposite relation to has_copy. |
is_creatable_on_child_add | No | boolean | Adding a new child object also automatically creates this relation type between the two parent-child objects. |
is_crows_foot_many | No | boolean | Used in Modeling diagrams. Indicates that the relation represents the many side in crow’s foot notation. The relation is created when two objects are linked with many on one side. The target object represents one of many related instances. |
is_crows_foot_none | No | boolean | Used in Modeling diagrams. The relation represents a none condition in crow’s foot notation, meaning no objects are related to the target object. |
is_crows_foot_one | No | boolean | Used in Modeling diagrams. The relation represents the one side in crow’s foot notation. Each source object is linked to exactly one target object. |
is_crows_foot_one_and_only_one | No | boolean | Used in Modeling diagrams. The relation represents a one and only one condition, enforcing a mandatory one-to-one relations between the linked objects. |
is_crows_foot_one_or_many | No | boolean | Used in Modeling diagrams. The relation represents a one or many condition, meaning each source object is related to at least one target object but potentially many. |
is_crows_foot_zero_or_many | No | boolean | Used in Modeling diagrams. The relation represents a zero or many condition, allowing an optional one-to-many relation between the linked objects. |
is_crows_foot_zero_or_one | No | boolean | Used in Modeling diagrams. The relation represents a zero or one condition, allowing an optional one-to-one relation between the linked objects. |
is_dependency | No | boolean | Used for impact analysis. Dependent objects (e.g., parent <-> child) are linked using this relation type. |
is_dependency_change | No | boolean | Used for impact analysis. Relation type change (adding or deleting a relation) runs an impact analysis. |
is_diagram_attribute_space_of | No | boolean | Used in knowledge graphs. The relation represents a connection between an object and a space. |
is_domain_of | No | boolean | Defines the relationship between a domain and the objects it applies to. This relation is used when domains are created in bulk, linking each domain to its associated objects. |
is_foreign_key | No | boolean | Defines the relation type as a foreign key, so any relations using it are treated as physical foreign key relationships. |
is_generated_by_exact_match | No | boolean | The relation type is created when one object mentions another by its full name in its attributes (exact name match). |
is_generated_by_keyword | No | boolean | The relation type is created when one object mentions another in its attributes. Used for tokenization (for more information, see Business Glossary). |
is_implicit | No | boolean | Marks automatically generated relations so that all relation types are included during export, even if they are not explicitly defined for the object type. |
is_lineage_parser_output | No | boolean | The relation type is automatically generated as the result of lineage parsing. |
is_mandatory | No | boolean | Marks the relation type as mandatory. This means that concepts can be published only after adding this relation type. |
is_not_presented_in_changes | No | boolean | Changes made to this relation type (adding or deleting) are excluded from the changelog. |
is_parent_inheritable | No | boolean | The relation type is inherited by all child objects. |
is_relation_in_space | Yes | boolean | [Legacy setting] Replaced by is_diagram_attribute_space_of. |
is_relation_space_of | Yes | boolean | [Legacy setting] Replaced by is_diagram_attribute_space_of. |
is_relation_type_acronym_of | Yes | boolean | Child objects are created as acronyms. Target object is the parent. Opposite relation to is_relation_type_has_acronym. |
is_relation_type_child_of | Yes | boolean | The relation type is created when a child object is created. Target object is the parent. Opposite relation to is_relation_type_parent_of. |
is_relation_type_diagram_contains | Yes | boolean | The relation type is created when a diagram with the object is created. Target object is the object. Opposite relation to is_relation_type_in_diagram. |
is_relation_type_domain_of | Yes | boolean | [Legacy setting] Replaced by is_domain_of. |
is_relation_type_has_acronym | Yes | boolean | Child objects are created as acronyms. Target object is the child (acronym). Opposite relation to is_relation_type_acronym_of. |
is_relation_type_has_domain | Yes | boolean | [Legacy setting] Replaced by is_domain_of. |
is_relation_type_in_diagram | Yes | boolean | The relation type is created when a diagram with the object is created. Target object is the diagram. Opposite relation to is_relation_type_diagram_contains. |
is_relation_type_parent_of | Yes | boolean | The relation type is created when a child object is created. Target object is the child. Opposite relation to is_relation_type_child_of. |
is_relation_type_referenced_by | Yes | boolean | The relation type is created when an object is linked in another object’s attribute using /. Target object is the referencing object. Opposite relation to is_relation_type_referencing. |
is_relation_type_referencing | Yes | boolean | The relation type is created when an object is linked in another object’s attribute using /. Target object is the referenced object. Opposite relation to is_relation_type_referenced_by. |
is_relation_type_synonym_of | Yes | boolean | Child objects are created as synonyms. Target object is the parent. |
is_relation_type_text_based_in | Yes | boolean | The relation type is created when an embedded object is unlinked. Target object is previously embedding object. Opposite relation to is_relation_type_text_based_on. |
is_relation_type_text_based_on | Yes | boolean | The relation type is created when an embedded object is unlinked. Target object is the previously embedded object. Opposite relation to is_relation_type_text_based_in. |
is_relation_type_used_text_in | Yes | boolean | The relation type is created when an object is embedded. Target object is the embedding object. Opposite relation to is_relation_type_using_text_of. |
is_relation_type_using_text_of | Yes | boolean | The relation type is created when an object is embedded. Target object is the embedded object. Opposite relation to is_relation_type_used_text_in. |
is_searchable_attribute | No | boolean | Allows the relation type to be searchable. |
is_self_targetable | No | boolean | Allows adding the relation to the same object (e.g., Object A <-> Object A). |
is_single_value | No | boolean | Restricts object to have only one relation of this type. |
is_stereotype | No | boolean | Used for physical diagrams. Connects objects with their stereotype definitions. |