Settings API - Generic relationships schema table
Generic relationships (builtin:monitoredentities.generic.relation)
Looking for topology extraction support? Find the topology model help page here.
Entity types can be related to each other. The relationship registry contains rules by which relationships between related entities are automatically established.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:monitoredentities.generic.relation |
| environment |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Enabled | boolean | Enables or disables the relationship | required |
| sources | Source filters | set | Specify all sources which should be evaluated for this relationship rule. The relationship is only created when any of the filters match. | required |
| createdBy | Created by | text | The user or extension that created this relationship. | required |
| fromType | Source type name | text | Define an entity type as the source of the relationship. | required |
| fromRole | Role of source type | text | Specify a role for the source entity. If both source and destination type are the same, referring different roles will allow identification of a relationships direction. If role is left blank, any role of the source type is considered for the relationship. | optional |
| typeOfRelation | Type of relationship | enum | Type of the relationship between the Source Type and the Destination Type | required |
| toType | Destination type | text | Define an entity type as the destination of the relationship. You can choose the same type as the source type. In this case you also may assign different roles for source and destination for having directed relationships. | required |
| toRole | Role of destination type | text | Specify a role for the destination entity. If both source and destination type are the same, referring different roles will allow identification of a relationships direction. If role is left blank, any role of the destination type is considered for the relationship. | optional |
Request body objects
The MappingRule object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| sourceProperty | Source property | text | The case-sensitive name of a property of the source type. | required |
| sourceTransformation | Source Normalization | enum | Normalize text or leave it as-is? | required |
| destinationProperty | Destination property | text | The case-sensitive name of a property of the destination type. | required |
| destinationTransformation | Destination Normalization | enum | Normalize text or leave it as-is? | required |
The SourceFilter object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| sourceType | Datasource type | enum | Specify the source type of the filter to identify which data source should be evaluated. | required |
| condition | Condition | text | Specify a filter that needs to match in order for the extraction to happen. Two different filters are supported: | required |
| mappingRules | Mapping Rules | set | Specify all properties which should be compared. If all mapping rules match a relationship between entities will be created. | required |