Service detection rules API - GET a rule

Shows the properties of the specified service detection rule.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/detectionRules/FULL_WEB_SERVICE/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/detectionRules/FULL_WEB_SERVICE/{id}

Parameters

Parameter Type Description In Required
id string

The ID of the required service detection rule.

path required

Response codes

Code Description
200 Success. The response contains properties of the specified rule.
404 Failed. The rule with the specified ID doesn't exist.

Response format

Refer to JSON models to find all JSON models that depend on the type of the model.

The FullWebServiceRule object

The service detection rule of the FULL_WEB_SERVICE type.

If you have a condition with the attributeType set to FRAMEWORK, the values field from compareOperations is limited to the following possible values: * AXIS

  • CXF
  • HESSIAN
  • JAX_WS_RI
  • JBOSS
  • JERSEY
  • PROGRESS
  • RESTEASY
  • RESTLET
  • SPRING
  • TIBCO
  • WEBLOGIC
  • WEBMETHODS
  • WEBSPHERE
  • WINK
Element Type Description
type string
metadata ConfigurationMetadata
managementZones string[]

Specifies the management zones of the process group for which this service detection rule should be created.

id string

The ID of the service detection rule.

order string

The order of the rule in the rules list.

The rules are evaluated from top to bottom. The first matching rule applies.

name string

The name of the rule.

description string

A short description of the rule.

enabled boolean

The rule is enabled(true) or disabled (false).

conditions ConditionsFullWebServiceAttributeTypeDto[]

A list of conditions of the rule.

If several conditions are specified, the AND logic applies.

detectAsWebRequestService boolean

Detect the matching requests as full web services (false) or web request services (true).

Setting this field to true prevents detecting of matching requests as full web services. A web request service is created instead. If you need to further modify the resulting web request service, you need to create a separate rule of the FULL_WEB_REQUEST type.

Default is false, detecting matching requests as full web services.

webServiceName WebServiceName
webServiceNameSpace WebServiceNameSpace
applicationId ApplicationId
contextRoot ContextRoot
serverName ServerName

The ServerName object

The contribution to the service ID calculation from the detected server name.

You have two mutually exclusive options:

  • Override the detected value with a specified static value. Specify the new value in the valueOverride field.
  • Dynamically transform the detected value. Specify the transformation parameters in the transformations field.
Element Type Description
transformations TransformationBase[]

Transformations to be applied to the detected value.

valueOverride string

The value to be used instead of the detected value.

The ContextRoot object

The contribution to the service ID calculation from the detected context root.

The context root is the first segment of the request URL after server name. For example, in the www.dynatrace.com/support/help/extend-dynatrace/dynatrace-api/ URL the context root is support.

You have two options:

  • Keep a part of the detected URL. Specify the number of segments to be kept in the segmentsToCopyFromUrlPath field.
  • Dynamically transform the detected URL. Specify the transformation parameters in the transformations field.

You can use one or both options. If you use both, the transformation applies to the modified URL.

Element Type Description
transformations ContextRootTransformation[]

Transformations to be applied to the detected value.

segmentsToCopyFromUrlPath integer

The number of segments of the URL to be kept.

The URL is divided by slashes (/), the indexing starts with 1 at context root.

For example, if you specify 2 for the www.dynatrace.com/support/help/dynatrace-api/ URL, the value of support/help is used.

The ContextRootTransformation object

Configuration of transformation of the detected value.

If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.

The actual set of fields depends on the type of the transformation.

Element Type Description
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • BEFORE -> BeforeTransformation
  • REPLACE_BETWEEN -> ReplaceBetweenTransformation
  • REMOVE_NUMBERS -> RemoveNumbersTransformation
  • REMOVE_CREDIT_CARDS -> RemoveCreditCardNumbersTransformation
  • REMOVE_IBANS -> RemoveIBANsTransformation
  • REMOVE_IPS -> RemoveIPsTransformation

The ApplicationId object

The contribution to the service ID calculation from the detected application ID.

You have two mutually exclusive options:

  • Override the detected value with a specified static value. Specify the new value in the valueOverride field.
  • Dynamically transform the detected value. Specify the transformation parameters in the transformations field.
Element Type Description
transformations TransformationBase[]

Transformations to be applied to the detected value.

valueOverride string

The value to be used instead of the detected value.

The WebServiceNameSpace object

The contribution to the service ID calculation from the detected web service name space.

You have two mutually exclusive options:

  • Override the detected value with a specified static value. Specify the new value in the valueOverride field.
  • Dynamically transform the detected value. Specify the transformation parameters in the transformations field.
Element Type Description
transformations TransformationBase[]

Transformations to be applied to the detected value.

valueOverride string

The value to be used instead of the detected value.

The WebServiceName object

The contribution to the service ID calculation from the detected web service name.

You have two mutually exclusive options:

  • Override the detected value with a specified static value. Specify the new value in the valueOverride field.
  • Dynamically transform the detected value. Specify the transformation parameters in the transformations field.
Element Type Description
transformations TransformationBase[]

Transformations to be applied to the detected value.

valueOverride string

The value to be used instead of the detected value.

The TransformationBase object

Configuration of transformation of the detected value.

If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.

The actual set of fields depends on the type of the transformation.

Element Type Description
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • BEFORE -> BeforeTransformation
  • AFTER -> AfterTransformation
  • BETWEEN -> BetweenTransformation
  • REPLACE_BETWEEN -> ReplaceBetweenTransformation
  • REMOVE_NUMBERS -> RemoveNumbersTransformation
  • REMOVE_CREDIT_CARDS -> RemoveCreditCardNumbersTransformation
  • REMOVE_IBANS -> RemoveIBANsTransformation
  • REMOVE_IPS -> RemoveIPsTransformation
  • SPLIT_SELECT -> SplitSelectTransformation
  • TAKE_SEGMENTS -> TakeSegmentsTransformation

The ConditionsFullWebServiceAttributeTypeDto object

A condition of the service detection rule.

Element Type Description
attributeType string

The type of the attribute to be checked.

compareOperations CompareOperation[]

A list of conditions for the rule.

If several conditions are specified, the AND logic applies.

The CompareOperation object

The condition of the rule.

The actual set of fields depends on the type of the condition.

Element Type Description
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • EQUALS -> EqualsCompareOperation
  • STRING_CONTAINS -> StringContainsCompareOperation
  • STARTS_WITH -> StartsWithCompareOperation
  • ENDS_WITH -> EndsWithCompareOperation
  • EXISTS -> ExistsCompareOperation
  • IP_IN_RANGE -> IpInRangeCompareOperation
  • LESS_THAN -> LessThanCompareOperation
  • GREATER_THAN -> GreaterThanCompareOperation
  • INT_EQUALS -> IntEqualsCompareOperation
  • STRING_EQUALS -> StringEqualsCompareOperation
  • TAG -> TagCompareOperation

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.