• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Generic relationships

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 IDSchema groupsScope
builtin:monitoredentities.generic.relation
  • group:topology-model
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:monitoredentities.generic.relation
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:monitoredentities.generic.relation
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:monitoredentities.generic.relation

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyLabelTypeDescriptionRequired
enabledEnabledboolean

Enables or disables the relationship

required
sourcesSource filtersset

Specify all sources which should be evaluated for this relationship rule. The relationship is only created when any of the filters match.

required
createdByCreated bytext

The user or extension that created this relationship.

required
fromTypeSource type nametext

Define an entity type as the source of the relationship.

required
fromRoleRole of source typetext

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
typeOfRelationType of relationshipenum

Type of the relationship between the Source Type and the Destination Type

required
toTypeDestination typetext

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
toRoleRole of destination typetext

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
PropertyLabelTypeDescriptionRequired
sourcePropertySource propertytext

The case-sensitive name of a property of the source type.

required
sourceTransformationSource Normalizationenum

Normalize text or leave it as-is?

required
destinationPropertyDestination propertytext

The case-sensitive name of a property of the destination type.

required
destinationTransformationDestination Normalizationenum

Normalize text or leave it as-is?

required
The SourceFilter object
PropertyLabelTypeDescriptionRequired
sourceTypeDatasource typeenum

Specify the source type of the filter to identify which data source should be evaluated.

required
conditionConditiontext

Specify a filter that needs to match in order for the extraction to happen.

Two different filters are supported: $eq(value) will ensure that the source matches exactly 'value', while $prefix(value) will ensure that the source begins with exactly 'value'. If your value contains the characters '(', ')' or '~', you need to escape them by adding a '~' in front of them.

required
mappingRulesMapping Rulesset

Specify all properties which should be compared. If all mapping rules match a relationship between entities will be created.

required