Settings API - Service detection rules for External Web Services schema table

Service detection rules for External Web Services (builtin:service-detection.external-web-service)

Rules are evaluated from top to bottom, and the first matching rule applies. Rule conditions are evaluated before Service Id Contributors are applied. Note that conditions do not modify attributes of requests. If conditions match, then Service Id Contributors are applied. All of the Contributors are always applied. But it is possible to influence the creation of Services by choosing how they get transformed.
More extensive information on Service detection rules can be found here.

Schema ID
Schema groups
Scope
builtin:service-detection.external-web-service
  • group:service-detection
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:service-detection.external-web-service
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:service-detection.external-web-service
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:service-detection.external-web-service

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

Property
Type
Description
Required
Enabled
enabled
boolean
-
required
Rule name
name
text
-
required
Description
description
text
-
optional
Management zones
managementZones
set

Define a management zone of the process group for which this service detection rule should be created. Note: in case of external requests/services the PG might not always be known. See here

required
Service identifier contributors
idContributors

Contributors to the Service Identifier calculation. URL path is always applied as an Id Contributor. You can exclude the port contribution by disabling the switch.

required
Conditions
conditions

A list of conditions necessary for the rule to take effect. If multiple conditions are specified, they must all match a Request for the rule to apply. If there is no condition at all, the rule is always applied. Conditions are evaluated against attributes, but do not modify them.

required
The idContributorsType object
Property
Type
Description
Required
Detect as web request service
detectAsWebRequestService
boolean

Detect the matching requests as web request services instead of web services.

This prevents detecting of matching requests as opaque web services. An opaque web request service is created instead. If you need to further modify the resulting web request service, you need to create a separate Opaque/external web request rule (<your-dynatrace-url>/builtin:service-detection.full-web-request).

required
URL path
urlPath
-
required
Port
portForServiceId
boolean

Let the port contribute to the Service Id

required
The condition object
Property
Type
Description
Required
Take the value of this attribute
attribute
text
-
required
Apply this operation
compareOperationType
text
-
required
Values
textValues
set

If multiple values are specified, at least one of them must match for the condition to match

required
Values
tagValues
set

If multiple values are specified, at least one of them must match for the condition to match

required
Value
intValue
integer
-
required
Values
intValues
set
-
required
From
ipRangeFrom
text
-
required
To
ipRangeTo
text
-
required
Technology
framework
  • AXIS
  • CXF
  • HESSIAN
  • JAX_WS_RI
  • JBOSS
  • JERSEY
  • PROGRESS
  • RESTEASY
  • RESTLET
  • SPRING
  • TIBCO
  • WEBLOGIC
  • WEBMETHODS
  • WEBSPHERE
  • WINK
required
Ignore case
ignoreCase
boolean

Ignore case sensitivity for texts.

required
The serviceIdContributor object
Property
Type
Description
Required
Transform this value before letting it contribute to the Service Id
enableIdContributor
boolean
-
required
serviceIdContributor
-
required
The transformationSet object
Property
Type
Description
Required
Contribution type
contributionType
enum

Defines whether the original value should be used or if a transformation set should be used to override a value or transform it.

  • OriginalValue
  • OverrideValue
  • TransformValue
required
Value override
valueOverride

The value to be used instead of the detected value.

required
Transformations
transformations

Choose how to transform a value before it contributes to the Service Id. Note that all of the Transformations are always applied. Transformations are applied in the order they are specified, and the output of the previous transformation is the input for the next one. The resulting value contributes to the Service Id and can be found on the Service overview page under Properties and tags.

required
The valueOverride object
Property
Type
Description
Required
Value
value
text
-
required
The transformation object
Property
Type
Description
Required
Transformation type
transformationType
enum

Defines what kind of transformation will be applied on the original value.

  • BEFORE
  • AFTER
  • BETWEEN
  • REPLACE_BETWEEN
  • REMOVE_NUMBERS
  • REMOVE_CREDIT_CARDS
  • REMOVE_IBANS
  • REMOVE_IPS
  • SPLIT_SELECT
  • TAKE_SEGMENTS
required
prefix
prefix
text
-
optional
suffix
suffix
text
-
optional
replacement
replacementValue
text
-
optional
split by
splitDelimiter
text
-
optional
select index
selectIndex
integer
-
required
min digit count
minDigitCount
integer
-
required
include hexadecimal numbers
includeHexNumbers
boolean
-
required
segment count
segmentCount
integer

How many segments should be taken.

required
take from end
takeFromEnd
boolean
-
required