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
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

PropertyTypeDescriptionRequired
Enabled
enabled		boolean

Enables or disables the relationship

required
Source filters
sources		Set<SourceFilter>

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

required
Created by
createdBy		text

The user or extension that created this relationship.

required
Source type name
fromType		text

Define an entity type as the source of the relationship.

required
Role of source type
fromRole		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
Type of relationship
typeOfRelation		enum

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

  • INSTANCE_OF
  • RUNS_ON
  • CHILD_OF
  • CALLS
  • PART_OF
  • SAME_AS
required
Destination type
toType		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
Role of destination type
toRole		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
The SourceFilter object
PropertyTypeDescriptionRequired
Datasource type
sourceType		enum

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

  • Metrics
  • Logs
  • Spans
  • Entities
  • Topology
  • Events
  • Business Events
required
Condition
condition		text

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
Mapping Rules
mappingRules		Set<MappingRule>

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

required
The MappingRule object
PropertyTypeDescriptionRequired
Source property
sourceProperty		text

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

required
Source Normalization
sourceTransformation		enum

Normalize text or leave it as-is?

  • Leave text as-is
  • To upper case
  • To lower case
required
Destination property
destinationProperty		text

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

required
Destination Normalization
destinationTransformation		enum

Normalize text or leave it as-is?

  • Leave text as-is
  • To upper case
  • To lower case
required