Service detection API - JSON models

Parameters JSON model

The FullWebRequestRule object

The service detection rule of the FULL_WEB_REQUEST type.

Element	Type	Description	Required
type	string	The type of the service detection rule.	required
metadata	ConfigurationMetadata		optional
managementZones	string[]	Specifies the management zones of the process group for which this service detection rule should be created.	optional
id	string	The ID of the service detection rule.	optional
order	string	The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies.	optional
name	string	The name of the rule.	required
description	string	A short description of the rule.	optional
enabled	boolean	The rule is enabled(`true`) or disabled (`false`).	required
conditions	ConditionsFullWebRequestAttributeTypeDto[]	A list of conditions of the rule. If several conditions are specified, the AND logic applies.	optional
applicationId	ApplicationId		optional
contextRoot	ContextRoot		optional
serverName	ServerName		optional

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	Required
transformations	TransformationBase[]	Transformations to be applied to the detected value.	optional
valueOverride	string	The value to be used instead of the detected value.	optional

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 Required

transformations

Element	Type	Description	Required
transformations	ContextRootTransformation[]	Transformations to be applied to the detected value.	optional
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.	optional

ContextRootTransformation[]

Transformations to be applied to the detected value.

optional

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.

optional

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 Required

type

string

Element	Type	Description	Required
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 element can hold these values BEFORE REMOVE_CREDIT_CARDS REMOVE_IBANS REMOVE_IPS REMOVE_NUMBERS REPLACE_BETWEEN	required

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 element can hold these values

BEFORE
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN

required

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	Required
transformations	TransformationBase[]	Transformations to be applied to the detected value.	optional
valueOverride	string	The value to be used instead of the detected value.	optional

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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

The ConditionsFullWebRequestAttributeTypeDto object

A condition of the service detection rule.

Element	Type	Description	Required
attributeType	string	The type of the attribute to be checked. The element can hold these values APPLICATION_ID CONTEXT_ROOT PG_TAG SERVER_NAME URL_HOST_NAME URL_PATH	required
compareOperations	CompareOperation[]	A list of conditions for the rule. If several conditions are specified, the AND logic applies.	optional

Element

Type

Description

Required

attributeType

string

The type of the attribute to be checked.

The element can hold these values

APPLICATION_ID
CONTEXT_ROOT
PG_TAG
SERVER_NAME
URL_HOST_NAME
URL_PATH

required

compareOperations

CompareOperation[]

A list of conditions for the rule.

If several conditions are specified, the AND logic applies.

optional

The CompareOperation object

The condition of the rule.

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

Element Type Description Required

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 element can hold these values

ENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG

required

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description	Required
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.	optional
currentConfigurationVersions	string[]	A Sorted list of string version numbers of the configuration.	optional
clusterVersion	string	Dynatrace server version.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "type": "FULL_WEB_REQUEST",  
  "id": "f69d6702-9b6e-4c47-b94c-628acc391995",
  "order": "1",
  "name": "string",
  "description": "string",
  "enabled": true,
  "conditions": [
    {
      "attributeType": "URL_PATH",
      "compareOperations": [
        {
          "type": "STRING_CONTAINS",
          "negate": false,
          "ignoreCase": true,
          "values": [
            "string"
          ]
        }
      ]
    }
  ],
  "applicationId": {
    "transformations": [],
    "valueOverride": "string"
  },
  "contextRoot": {
    "transformations": [
      {
        "type": "AFTER",
        "delimiter": "string"
      }
    ],
    "segmentsToCopyFromUrlPath": 2
  },
  "serverName": {
    "transformations": [
      {
        "type": "BEFORE",
        "delimiter": "string"
      }
    ]
  }
}

OpaqueAndExternalWebRequestRule

Parameters JSON model

The OpaqueAndExternalWebRequestRule object

The service detection rule of the OPAQUE_AND_EXTERNAL_WEB_REQUEST type.

Element	Type	Description	Required
type	string	The type of the service detection rule.	required
metadata	ConfigurationMetadata		optional
managementZones	string[]	Specifies the management zones of the process group for which this service detection rule should be created.	optional
id	string	The ID of the service detection rule.	optional
order	string	The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies.	optional
name	string	The name of the rule.	required
description	string	A short description of the rule.	optional
enabled	boolean	The rule is enabled(`true`) or disabled (`false`).	required
conditions	ConditionsOpaqueAndExternalWebRequestAttributeTypeDto[]	A list of conditions of the rule. If several conditions are specified, the AND logic applies.	optional
applicationId	ApplicationId		optional
contextRoot	ContextRoot		optional
port	Port		optional
publicDomainName	PublicDomainName		optional

The PublicDomainName object

The contribution to the service ID calculation from the domain name where the web request has been detected.

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 Required

transformations

TransformationBase[]

Transformations to be applied to the detected value.

optional

valueOverride

string

The value to be used instead of the detected value.

optional

copyFromHostName

boolean

Use (true) or don't use (false) the detected host name as base for transformation.

Not applicable if the override is specified.

optional

The Port object

The contribution to the service ID calculation from the port, where the web request has been detected.

Element	Type	Description	Required
doNotUseForServiceId	boolean	The port is used (`false`) or isn't used (`true`) in the service ID calculation.	optional

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 Required

transformations

Element	Type	Description	Required
transformations	ContextRootTransformation[]	Transformations to be applied to the detected value.	optional
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.	optional

ContextRootTransformation[]

Transformations to be applied to the detected value.

optional

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.

optional

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 Required

type

string

Element	Type	Description	Required
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 element can hold these values BEFORE REMOVE_CREDIT_CARDS REMOVE_IBANS REMOVE_IPS REMOVE_NUMBERS REPLACE_BETWEEN	required

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 element can hold these values

BEFORE
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN

required

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	Required
transformations	TransformationBase[]	Transformations to be applied to the detected value.	optional
valueOverride	string	The value to be used instead of the detected value.	optional

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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

The ConditionsOpaqueAndExternalWebRequestAttributeTypeDto object

A condition of the service detection rule.

Element	Type	Description	Required
attributeType	string	The type of the attribute to be checked. The element can hold these values IP PG_TAG TOP_LEVEL_DOMAIN URL URL_HOST_NAME URL_PATH URL_PORT	required
compareOperations	CompareOperation[]	A list of conditions for the rule. If several conditions are specified, the AND logic applies.	optional

Element

Type

Description

Required

attributeType

string

The type of the attribute to be checked.

The element can hold these values

IP
PG_TAG
TOP_LEVEL_DOMAIN
URL
URL_HOST_NAME
URL_PATH
URL_PORT

required

compareOperations

CompareOperation[]

A list of conditions for the rule.

If several conditions are specified, the AND logic applies.

optional

The CompareOperation object

The condition of the rule.

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

Element Type Description Required

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 element can hold these values

ENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG

required

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description	Required
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.	optional
currentConfigurationVersions	string[]	A Sorted list of string version numbers of the configuration.	optional
clusterVersion	string	Dynatrace server version.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "type": "OPAQUE_AND_EXTERNAL_WEB_REQUEST",
  "id": "9c22d0b1-e731-4baf-b3d0-140d14ead3c5",
  "order": "2",
  "name": "string",
  "description": "string",
  "enabled": true,
  "conditions": [
    {
      "attributeType": "TOP_LEVEL_DOMAIN",
      "compareOperations": [
        {
          "type": "ENDS_WITH",
          "negate": false,
          "ignoreCase": true,
          "values": [
            "string"
          ]
        }
      ]
    }
  ],
  "applicationId": null,
  "contextRoot": {
    "transformations": [],
    "segmentsToCopyFromUrlPath": 1
  },
  "port": null,
  "publicDomainName": null
}

FullWebServiceRule

Parameters JSON 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	Required
type	string	The type of the service detection rule.	required
metadata	ConfigurationMetadata		optional
managementZones	string[]	Specifies the management zones of the process group for which this service detection rule should be created.	optional
id	string	The ID of the service detection rule.	optional
order	string	The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies.	optional
name	string	The name of the rule.	required
description	string	A short description of the rule.	optional
enabled	boolean	The rule is enabled(`true`) or disabled (`false`).	required
conditions	ConditionsFullWebServiceAttributeTypeDto[]	A list of conditions of the rule. If several conditions are specified, the AND logic applies.	optional
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.	optional
webServiceName	WebServiceName		optional
webServiceNameSpace	WebServiceNameSpace		optional
applicationId	ApplicationId		optional
contextRoot	ContextRoot		optional
serverName	ServerName		optional

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	Required
transformations	TransformationBase[]	Transformations to be applied to the detected value.	optional
valueOverride	string	The value to be used instead of the detected value.	optional

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 Required

transformations

Element	Type	Description	Required
transformations	ContextRootTransformation[]	Transformations to be applied to the detected value.	optional
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.	optional

ContextRootTransformation[]

Transformations to be applied to the detected value.

optional

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.

optional

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 Required

type

string

Element	Type	Description	Required
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 element can hold these values BEFORE REMOVE_CREDIT_CARDS REMOVE_IBANS REMOVE_IPS REMOVE_NUMBERS REPLACE_BETWEEN	required

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 element can hold these values

BEFORE
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN

required

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	Required
transformations	TransformationBase[]	Transformations to be applied to the detected value.	optional
valueOverride	string	The value to be used instead of the detected value.	optional

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	Required
transformations	TransformationBase[]	Transformations to be applied to the detected value.	optional
valueOverride	string	The value to be used instead of the detected value.	optional

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	Required
transformations	TransformationBase[]	Transformations to be applied to the detected value.	optional
valueOverride	string	The value to be used instead of the detected value.	optional

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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

The ConditionsFullWebServiceAttributeTypeDto object

A condition of the service detection rule.

Element	Type	Description	Required
attributeType	string	The type of the attribute to be checked. The element can hold these values APPLICATION_ID CONTEXT_ROOT FRAMEWORK IS_SOAP_SERVICE PG_TAG SERVER_NAME URL_HOST_NAME URL_PATH WEBSERVICE_METHOD WEBSERVICE_NAME WEBSERVICE_NAMESPACE	required
compareOperations	CompareOperation[]	A list of conditions for the rule. If several conditions are specified, the AND logic applies.	optional

Element

Type

Description

Required

attributeType

string

The type of the attribute to be checked.

The element can hold these values

APPLICATION_ID
CONTEXT_ROOT
FRAMEWORK
IS_SOAP_SERVICE
PG_TAG
SERVER_NAME
URL_HOST_NAME
URL_PATH
WEBSERVICE_METHOD
WEBSERVICE_NAME
WEBSERVICE_NAMESPACE

required

compareOperations

CompareOperation[]

A list of conditions for the rule.

If several conditions are specified, the AND logic applies.

optional

The CompareOperation object

The condition of the rule.

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

Element Type Description Required

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 element can hold these values

ENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG

required

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description	Required
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.	optional
currentConfigurationVersions	string[]	A Sorted list of string version numbers of the configuration.	optional
clusterVersion	string	Dynatrace server version.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "type": "FULL_WEB_SERVICE",  
  "id": "string",
  "order": "1",
  "name": "string",
  "description": "string",
  "enabled": true,
  "conditions": [
    {
      "attributeType": "URL_PATH",
      "compareOperations": [
        {
          "type": "STRING_CONTAINS",
          "negate": false,
          "ignoreCase": true,
          "values": [
            "string"
          ]
        }
      ]
    }
  ],
  "detectWebRequestOnly": false,
  "webServiceName" : {
    "valueOverride": "string",
    "transformations": []
  },
  "webServiceNameSpace": {
    "valueOverride": "string",
    "transformations": []
  },
  "applicationId": {
    "transformations": [],
    "valueOverride": "string"
  },
  "contextRoot": {
    "transformations": [
      {
        "type": "AFTER",
        "delimiter": "string"
      }
    ],
    "segmentsToCopyFromUrlPath": 2
  },
  "serverName": {
    "transformations": [
      {
        "type": "BEFORE",
        "delimiter": "string"
      }
    ]
  }
}

StringContainsCompareOperation

Parameters JSON model

The StringContainsCompareOperation object

The condition of the rule.

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

Element	Type	Description	Required
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 element can hold these values ENDS_WITH EQUALS EXISTS GREATER_THAN INT_EQUALS IP_IN_RANGE LESS_THAN STARTS_WITH STRING_CONTAINS STRING_EQUALS TAG	required
negate	boolean	Inverts the operation of the condition. Set to `true` to turn contains into does not contain. If not set, then `false` is used.	optional
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive.	optional
values	string[]	The value to compare to. If several values are specified, the OR logic applies.	optional

{
  "type": "STRING_CONTAINS",
  "negate": false,
  "ignoreCase": true,
  "values": [
    "compareValue1",
    "compareValue2"
  ]
}

StringEqualsCompareOperation

Parameters JSON model

The StringEqualsCompareOperation object

The condition of the rule.

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

Element	Type	Description	Required
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 element can hold these values ENDS_WITH EQUALS EXISTS GREATER_THAN INT_EQUALS IP_IN_RANGE LESS_THAN STARTS_WITH STRING_CONTAINS STRING_EQUALS TAG	required
negate	boolean	Inverts the operation of the condition. Set to `true` to turn equals into does not equal. If not set, then `false` is used.	optional
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive.	optional
values	string[]	The value to compare to. If several values are specified, the OR logic applies.	optional

{
  "type": "STRING_EQUALS",
  "negate": false,
  "ignoreCase": true,
  "values": [
    "compareValue1",
    "compareValue2"
  ]
}

StartsWithCompareOperation

Parameters JSON model

The StartsWithCompareOperation object

The condition of the rule.

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

Element	Type	Description	Required
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 element can hold these values ENDS_WITH EQUALS EXISTS GREATER_THAN INT_EQUALS IP_IN_RANGE LESS_THAN STARTS_WITH STRING_CONTAINS STRING_EQUALS TAG	required
negate	boolean	Inverts the operation of the condition. Set to `true` to turn starts with into does not start with. If not set, then `false` is used.	optional
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive.	optional
values	string[]	The value to compare to. If several values are specified, the OR logic applies.	optional

{
  "type": "STARTS_WITH",
  "negate": false,
  "ignoreCase": true,
  "values": [
    "compareValue1",
    "compareValue2"
  ]
}

EndsWithCompareOperation

Parameters JSON model

The EndsWithCompareOperation object

The condition of the rule.

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

Element	Type	Description	Required
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 element can hold these values ENDS_WITH EQUALS EXISTS GREATER_THAN INT_EQUALS IP_IN_RANGE LESS_THAN STARTS_WITH STRING_CONTAINS STRING_EQUALS TAG	required
negate	boolean	Inverts the operation of the condition. Set to `true` to turn ends with into does not end with. If not set, then `false` is used.	optional
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive.	optional
values	string[]	The value to compare to. If several values are specified, the OR logic applies.	optional

{
  "type": "ENDS_WITH",
  "negate": false,
  "ignoreCase": true,
  "values": [
    "compareValue1",
    "compareValue2"
  ]
}

ExistsCompareOperation

Parameters JSON model

The ExistsCompareOperation object

The condition of the rule.

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

Element Type Description Required

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 element can hold these values

ENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG

required

negate

boolean

Inverts the operation of the condition. Set to true to turn exists into does not exist.

If not set, then false is used.

optional

{
  "type": "EXISTS",
  "negate": false
}

IpInRangeCompareOperation

Parameters JSON model

The IpInRangeCompareOperation object

The condition of the rule.

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

Element	Type	Description	Required
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 element can hold these values ENDS_WITH EQUALS EXISTS GREATER_THAN INT_EQUALS IP_IN_RANGE LESS_THAN STARTS_WITH STRING_CONTAINS STRING_EQUALS TAG	required
negate	boolean	Inverts the operation of the condition. Set to `true` to turn IP is in range into IP is not in range. If not set, then `false` is used.	optional
lower	string	The lower boundary of the IP range.	required
upper	string	The upper boundary of the IP range.	required

{
  "type": "IP_IN_RANGE",
  "negate": false,
  "lower": "192.168.0.1",
  "upper": "192.168.0.10"
}

IntEqualsCompareOperation

Parameters JSON model

The IntEqualsCompareOperation object

The condition of the rule.

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

Element Type Description Required

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 element can hold these values

ENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG

required

negate

boolean

Inverts the operation of the condition. Set to true to turn equals into does not equal.

If not set, then false is used.

optional

values

integer[]

The value to compare to.

If several values are specified, the OR logic applies.

optional

{
  "type": "INT_EQUALS",
  "negate": false,
  "values": [
    128,
    258,
    512
  ]
}

LessThanCompareOperation

Parameters JSON model

The LessThanCompareOperation object

The condition of the rule.

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

Element Type Description Required

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 element can hold these values

ENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG

required

value

integer

The value to compare to.

required

{
  "type": "LESS_THAN",  
  "value": 512
}

GreaterThanCompareOperation

Parameters JSON model

The GreaterThanCompareOperation object

The condition of the rule.

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

Element Type Description Required

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 element can hold these values

ENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG

required

value

integer

The value to compare to.

required

{
  "type": "GREATER_THAN",  
  "value": 256
}

BeforeTransformation

Parameters JSON model

The BeforeTransformation 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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

delimiter

string

The delimiter of the transformation. The transformation keeps everything before this delimiter and removes everything after it.

The delimiter itself is not kept.

If several delimiters appear in the initial value, only the first one is used.

required

{
  "type": "BEFORE",
  "delimiter": "/"
}

AfterTransformation

Parameters JSON model

The AfterTransformation 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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

delimiter

string

The delimiter of the transformation. The transformation removes everything before this delimiter and keeps everything after it.

The delimiter itself is not kept.

If several delimiters appear in the initial value, only the first one is used.

required

{
  "type": "AFTER",
  "delimiter": "/"
}

BetweenTransformation

Parameters JSON model

The BetweenTransformation 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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

after

string

The starting delimiter. The transformation removes everything before it. The delimiter itself is not kept.

required

before

string

The ending delimiter. The transformation removes everything after it. The delimiter itself is not kept.

required

{
  "type": "BETWEEN",
  "after": "support",
  "before": "/"
}

ReplaceBetweenTransformation

Parameters JSON model

The ReplaceBetweenTransformation 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	Required
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 element can hold these values AFTER BEFORE BETWEEN REMOVE_CREDIT_CARDS REMOVE_IBANS REMOVE_IPS REMOVE_NUMBERS REPLACE_BETWEEN SPLIT_SELECT TAKE_SEGMENTS	required
after	string	The starting delimiter. The transformation removes everything before it. The delimiter itself is not kept.	required
before	string	The ending delimiter. The transformation removes everything after it. The delimiter itself is not kept.	required
replacement	string	The value to be used instead of the detected value.	required

{
  "type": "REPLACE_BETWEEN",
  "after": "support",
  "before": "/",
  "replacement": "newValue"
}

RemoveNumbersTransformation

Parameters JSON model

The RemoveNumbersTransformation 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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

minDigitCount

integer

Remove numbers that contain at least X digits.

required

includeHexNumbers

boolean

Remove (true) or keep (false) hexadecimal numbers.

If not set, then false is used, keeping hexadecimal numbers.

optional

{
  "type": "REMOVE_NUMBERS",
  "minDigitCount": 2,
  "includeHexNumbers": true
}

RemoveCreditCardNumbersTransformation

Parameters JSON model

The RemoveCreditCardNumbersTransformation 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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

{
  "type": "REMOVE_CREDIT_CARDS"
}

RemoveIBANsTransformation

Parameters JSON model

The RemoveIBANsTransformation 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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

{
  "type": "REMOVE_IBANS"
}

RemoveIPsTransformation

Parameters JSON model

The RemoveIPsTransformation 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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

{
  "type": "REMOVE_IPS"
}

SplitSelectTransformation

Parameters JSON model

The SplitSelectTransformation 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 Required

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 element can hold these values

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

required

delimiter

string

The delimiter for splitting the detected value. The delimiter itself is not kept.

required

itemIndex

integer

The index of the element in the split array to be used. Indexing starts with 1.

required

{
  "type": "SPLIT_SELECT",
  "delimiter": "/",
  "itemIndex": 2
}

TakeSegmentsTransformation

Parameters JSON model

The TakeSegmentsTransformation 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	Required
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 element can hold these values AFTER BEFORE BETWEEN REMOVE_CREDIT_CARDS REMOVE_IBANS REMOVE_IPS REMOVE_NUMBERS REPLACE_BETWEEN SPLIT_SELECT TAKE_SEGMENTS	required
segmentCount	integer	The number of elements to be kept.	required
delimiter	string	The delimiter for splitting the detected value. The delimiter itself is not kept.	required
takeFromEnd	boolean	Keeps the first (`false`) or last (`true`) elements. If not set, then `false` is used, keeping the first elements.	optional

{
  "type": "TAKE_SEGMENTS",
  "delimiter": "/",
  "takeFromEnd": false
}

Variations of the ServiceDetectionRule object

FULL_WEB_REQUEST

The FullWebRequestRule object

The ServerName object

The ContextRoot object

The ContextRootTransformation object

The ApplicationId object

The TransformationBase object

The ConditionsFullWebRequestAttributeTypeDto object

The CompareOperation object

The ConfigurationMetadata object

OPAQUE_AND_EXTERNAL_WEB_REQUEST

The OpaqueAndExternalWebRequestRule object

The PublicDomainName object

The Port object

The ContextRoot object

The ContextRootTransformation object

The ApplicationId object

The TransformationBase object

The ConditionsOpaqueAndExternalWebRequestAttributeTypeDto object

The CompareOperation object

The ConfigurationMetadata object

FULL_WEB_SERVICE

The FullWebServiceRule object

The ServerName object

The ContextRoot object

The ContextRootTransformation object

The ApplicationId object

The WebServiceNameSpace object

The WebServiceName object

The TransformationBase object

The ConditionsFullWebServiceAttributeTypeDto object

The CompareOperation object

The ConfigurationMetadata object

Variations of the CompareOperation object

STRING_CONTAINS

The StringContainsCompareOperation object

STRING_EQUALS

The StringEqualsCompareOperation object

STARTS_WITH

The StartsWithCompareOperation object

ENDS_WITH

The EndsWithCompareOperation object

EXISTS

The ExistsCompareOperation object

IP_IN_RANGE

The IpInRangeCompareOperation object

INT_EQUALS

The IntEqualsCompareOperation object

LESS_THAN

The LessThanCompareOperation object

GREATER_THAN

The GreaterThanCompareOperation object

Variations of the Transformation object

BEFORE

The BeforeTransformation object

AFTER

The AfterTransformation object

BETWEEN

The BetweenTransformation object

REPLACE_BETWEEN

The ReplaceBetweenTransformation object

REMOVE_NUMBERS

The RemoveNumbersTransformation object

REMOVE_CREDIT_CARDS

The RemoveCreditCardNumbersTransformation object

REMOVE_IBANS

The RemoveIBANsTransformation object

REMOVE_IPS

The RemoveIPsTransformation object

SPLIT_SELECT

The SplitSelectTransformation object

TAKE_SEGMENTS

The TakeSegmentsTransformation object

Variations of the `ServiceDetectionRule` object

Variations of the `CompareOperation` object

Variations of the `Transformation` object