Service detection API - JSON models

JSON models of the Service detection rules API vary greatly, depending on the type of some objects. Here you can find JSON models for each variation.

Variations of the `ServiceDetectionRule` object

The ServiceDetectionRule object is the base for all service detection rules. The actual set of fields depends on the type of the rule.

FULL_WEB_REQUEST

FullWebRequestRule

ParametersJSON model

The `FullWebRequestRule` object

The service detection rule of the FULL_WEB_REQUEST type.

Element	Type	Description
type	string	The type of the service detection rule.
metadata	ConfigurationMetadata	Metadata useful for debugging Can be `null`.
managementZones	string[]	The management zone (specified by the ID) of the process group for which this service detection rule should be created. You can specify only 1 management zone here. Can be `null`.
id	string	The ID of the service detection rule. Can be `null`.
order	string	The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies. Can be `null`.
name	string	The name of the rule.
description	string	A short description of the rule. Can be `null`.
enabled	boolean	The rule is enabled(`true`) or disabled (`false`).
conditions	ConditionsFullWebRequestAttributeTypeDto[]	A list of conditions of the rule. If several conditions are specified, the AND logic applies. Can be `null`.
applicationId	ApplicationId	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. Can be `null`.
contextRoot	ContextRoot	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/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. Can be `null`.
serverName	ServerName	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. Can be `null`.

The `ConfigurationMetadata` object

Metadata useful for debugging

Element Type Description

configurationVersions

integer[]

Element	Type	Description
configurationVersions	integer[]	A sorted list of the version numbers of the configuration. Can be `null`.
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration. Can be `null`.
clusterVersion	string	Dynatrace version. Can be `null`.

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersions

string[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersion

string

Dynatrace version.

Can be null.

The `ConditionsFullWebRequestAttributeTypeDto` object

A condition of the service detection rule.

Element Type Description

attributeType

string

Element	Type	Description
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`
compareOperations	CompareOperation[]	A list of conditions for the rule. If several conditions are specified, the AND logic applies. Can be `null`.

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

compareOperations

CompareOperation[]

A list of conditions for the rule.

If several conditions are specified, the AND logic applies.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

Element	Type	Description
transformations	TransformationBase[]	Transformations to be applied to the detected value. Can be `null`.
valueOverride	string	The value to be used instead of the detected value. Can be `null`.

TransformationBase[]

Transformations to be applied to the detected value.

Can be null.

valueOverride

string

The value to be used instead of the detected value.

Can be null.

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. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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 element can hold these values `AFTER` `BEFORE` `BETWEEN` `REMOVE_CREDIT_CARDS` `REMOVE_IBANS` `REMOVE_IPS` `REMOVE_NUMBERS` `REPLACE_BETWEEN` `SPLIT_SELECT` `TAKE_SEGMENTS`

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

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

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

ContextRootTransformation[]

Transformations to be applied to the detected value.

Can be null.

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.

Can be null.

The `ContextRootTransformation` object

Configuration of transformation of the detected value.

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

Element Type Description

type

string

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 element can hold these values `BEFORE` `REMOVE_CREDIT_CARDS` `REMOVE_IBANS` `REMOVE_IPS` `REMOVE_NUMBERS` `REPLACE_BETWEEN`

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

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

Element	Type	Description
transformations	TransformationBase[]	Transformations to be applied to the detected value. Can be `null`.
valueOverride	string	The value to be used instead of the detected value. Can be `null`.

TransformationBase[]

Transformations to be applied to the detected value.

Can be null.

valueOverride

string

The value to be used instead of the detected value.

Can be null.

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

json
{
  "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"
      }
    ]
  }
}

OPAQUE_AND_EXTERNAL_WEB_REQUEST

OpaqueAndExternalWebRequestRule

ParametersJSON model

The `OpaqueAndExternalWebRequestRule` object

The service detection rule of the OPAQUE_AND_EXTERNAL_WEB_REQUEST type.

Element	Type	Description
type	string	The type of the service detection rule.
metadata	ConfigurationMetadata	Metadata useful for debugging Can be `null`.
managementZones	string[]	The management zone (specified by the ID) of the process group for which this service detection rule should be created. You can specify only 1 management zone here. Can be `null`.
id	string	The ID of the service detection rule. Can be `null`.
order	string	The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies. Can be `null`.
name	string	The name of the rule.
description	string	A short description of the rule. Can be `null`.
enabled	boolean	The rule is enabled(`true`) or disabled (`false`).
conditions	ConditionsOpaqueAndExternalWebRequestAttributeTypeDto[]	A list of conditions of the rule. If several conditions are specified, the AND logic applies. Can be `null`.
applicationId	ApplicationId	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. Can be `null`.
contextRoot	ContextRoot	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/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. Can be `null`.
port	Port	The contribution to the service ID calculation from the port, where the web request has been detected. Can be `null`.
publicDomainName	PublicDomainName	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. Can be `null`.

The `ConfigurationMetadata` object

Metadata useful for debugging

Element Type Description

configurationVersions

integer[]

Element	Type	Description
configurationVersions	integer[]	A sorted list of the version numbers of the configuration. Can be `null`.
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration. Can be `null`.
clusterVersion	string	Dynatrace version. Can be `null`.

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersions

string[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersion

string

Dynatrace version.

Can be null.

The `ConditionsOpaqueAndExternalWebRequestAttributeTypeDto` object

A condition of the service detection rule.

Element Type Description

attributeType

string

Element	Type	Description
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`
compareOperations	CompareOperation[]	A list of conditions for the rule. If several conditions are specified, the AND logic applies. Can be `null`.

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

compareOperations

CompareOperation[]

A list of conditions for the rule.

If several conditions are specified, the AND logic applies.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

Element	Type	Description
transformations	TransformationBase[]	Transformations to be applied to the detected value. Can be `null`.
valueOverride	string	The value to be used instead of the detected value. Can be `null`.

TransformationBase[]

Transformations to be applied to the detected value.

Can be null.

valueOverride

string

The value to be used instead of the detected value.

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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 element can hold these values `AFTER` `BEFORE` `BETWEEN` `REMOVE_CREDIT_CARDS` `REMOVE_IBANS` `REMOVE_IPS` `REMOVE_NUMBERS` `REPLACE_BETWEEN` `SPLIT_SELECT` `TAKE_SEGMENTS`

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

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

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

ContextRootTransformation[]

Transformations to be applied to the detected value.

Can be null.

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.

Can be null.

The `ContextRootTransformation` object

Configuration of transformation of the detected value.

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

Element Type Description

type

string

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 element can hold these values `BEFORE` `REMOVE_CREDIT_CARDS` `REMOVE_IBANS` `REMOVE_IPS` `REMOVE_NUMBERS` `REPLACE_BETWEEN`

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

The `Port` object

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

Element Type Description

doNotUseForServiceId

boolean

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

The port is used (false) or isn't used (true) in the service ID calculation.

Can be null.

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

transformations

Element	Type	Description
transformations	TransformationBase[]	Transformations to be applied to the detected value. Can be `null`.
valueOverride	string	The value to be used instead of the detected value. Can be `null`.
copyFromHostName	boolean	Use (`true`) or don't use (`false`) the detected host name as base for transformation. Not applicable if the override is specified. Can be `null`.

TransformationBase[]

Transformations to be applied to the detected value.

Can be null.

valueOverride

string

The value to be used instead of the detected value.

Can be null.

copyFromHostName

boolean

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

Not applicable if the override is specified.

Can be null.

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

json
{
  "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
}

FULL_WEB_SERVICE

FullWebServiceRule

ParametersJSON 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	The type of the service detection rule.
metadata	ConfigurationMetadata	Metadata useful for debugging Can be `null`.
managementZones	string[]	The management zone (specified by the ID) of the process group for which this service detection rule should be created. You can specify only 1 management zone here. Can be `null`.
id	string	The ID of the service detection rule. Can be `null`.
order	string	The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies. Can be `null`.
name	string	The name of the rule.
description	string	A short description of the rule. Can be `null`.
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. Can be `null`.
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. Can be `null`.
webServiceName	WebServiceName	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. Can be `null`.
webServiceNameSpace	WebServiceNameSpace	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. Can be `null`.
applicationId	ApplicationId	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. Can be `null`.
contextRoot	ContextRoot	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/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. Can be `null`.
serverName	ServerName	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. Can be `null`.

The `ConfigurationMetadata` object

Metadata useful for debugging

Element Type Description

configurationVersions

integer[]

Element	Type	Description
configurationVersions	integer[]	A sorted list of the version numbers of the configuration. Can be `null`.
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration. Can be `null`.
clusterVersion	string	Dynatrace version. Can be `null`.

A sorted list of the version numbers of the configuration.

Can be null.

currentConfigurationVersions

string[]

A sorted list of version numbers of the configuration.

Can be null.

clusterVersion

string

Dynatrace version.

Can be null.

The `ConditionsFullWebServiceAttributeTypeDto` object

A condition of the service detection rule.

Element Type Description

attributeType

string

Element	Type	Description
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`
compareOperations	CompareOperation[]	A list of conditions for the rule. If several conditions are specified, the AND logic applies. Can be `null`.

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

compareOperations

CompareOperation[]

A list of conditions for the rule.

If several conditions are specified, the AND logic applies.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

Element	Type	Description
transformations	TransformationBase[]	Transformations to be applied to the detected value. Can be `null`.
valueOverride	string	The value to be used instead of the detected value. Can be `null`.

TransformationBase[]

Transformations to be applied to the detected value.

Can be null.

valueOverride

string

The value to be used instead of the detected value.

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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 element can hold these values `AFTER` `BEFORE` `BETWEEN` `REMOVE_CREDIT_CARDS` `REMOVE_IBANS` `REMOVE_IPS` `REMOVE_NUMBERS` `REPLACE_BETWEEN` `SPLIT_SELECT` `TAKE_SEGMENTS`

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

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

Element	Type	Description
transformations	TransformationBase[]	Transformations to be applied to the detected value. Can be `null`.
valueOverride	string	The value to be used instead of the detected value. Can be `null`.

TransformationBase[]

Transformations to be applied to the detected value.

Can be null.

valueOverride

string

The value to be used instead of the detected value.

Can be null.

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

Element	Type	Description
transformations	TransformationBase[]	Transformations to be applied to the detected value. Can be `null`.
valueOverride	string	The value to be used instead of the detected value. Can be `null`.

TransformationBase[]

Transformations to be applied to the detected value.

Can be null.

valueOverride

string

The value to be used instead of the detected value.

Can be null.

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

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

ContextRootTransformation[]

Transformations to be applied to the detected value.

Can be null.

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.

Can be null.

The `ContextRootTransformation` object

Configuration of transformation of the detected value.

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

Element Type Description

type

string

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 element can hold these values `BEFORE` `REMOVE_CREDIT_CARDS` `REMOVE_IBANS` `REMOVE_IPS` `REMOVE_NUMBERS` `REPLACE_BETWEEN`

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

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

Element	Type	Description
transformations	TransformationBase[]	Transformations to be applied to the detected value. Can be `null`.
valueOverride	string	The value to be used instead of the detected value. Can be `null`.

TransformationBase[]

Transformations to be applied to the detected value.

Can be null.

valueOverride

string

The value to be used instead of the detected value.

Can be null.

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

json
{
  "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"
      }
    ]
  }
}

Variations of the `CompareOperation` object

The CompareOperation object is the base for all comparison operations. The actual set of fields depends on the type of the comparison.

STRING_CONTAINS

StringContainsCompareOperation

ParametersJSON model

The `StringContainsCompareOperation` object

Element Type Description

negate

boolean

Element	Type	Description
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. Can be `null`.
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive. Can be `null`.
values	string[]	The value to compare to. If several values are specified, the OR logic applies. Can be `null`.

Inverts the operation of the condition. Set to true to turn contains into does not contain.

If not set, then false is used.

Can be null.

ignoreCase

boolean

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

Can be null.

values

string[]

The value to compare to.

If several values are specified, the OR logic applies.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

STRING_EQUALS

StringEqualsCompareOperation

ParametersJSON model

The `StringEqualsCompareOperation` object

Element Type Description

negate

boolean

Element	Type	Description
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. Can be `null`.
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive. Can be `null`.
values	string[]	The value to compare to. If several values are specified, the OR logic applies. Can be `null`.

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

If not set, then false is used.

Can be null.

ignoreCase

boolean

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

Can be null.

values

string[]

The value to compare to.

If several values are specified, the OR logic applies.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

STARTS_WITH

StartsWithCompareOperation

ParametersJSON model

The `StartsWithCompareOperation` object

Element Type Description

negate

boolean

Element	Type	Description
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. Can be `null`.
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive. Can be `null`.
values	string[]	The value to compare to. If several values are specified, the OR logic applies. Can be `null`.

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.

Can be null.

ignoreCase

boolean

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

Can be null.

values

string[]

The value to compare to.

If several values are specified, the OR logic applies.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

ENDS_WITH

EndsWithCompareOperation

ParametersJSON model

The `EndsWithCompareOperation` object

Element Type Description

negate

boolean

Element	Type	Description
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. Can be `null`.
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive. Can be `null`.
values	string[]	The value to compare to. If several values are specified, the OR logic applies. Can be `null`.

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.

Can be null.

ignoreCase

boolean

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

Can be null.

values

string[]

The value to compare to.

If several values are specified, the OR logic applies.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

EXISTS

ExistsCompareOperation

ParametersJSON model

The `ExistsCompareOperation` object

Element Type Description

negate

boolean

Element	Type	Description
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. Can be `null`.

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

If not set, then false is used.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

IP_IN_RANGE

IpInRangeCompareOperation

ParametersJSON model

The `IpInRangeCompareOperation` object

Element Type Description

negate

boolean

Element	Type	Description
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. Can be `null`.
lower	string	The lower boundary of the IP range. Can be `null`.
upper	string	The upper boundary of the IP range. Can be `null`.

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.

Can be null.

lower

string

The lower boundary of the IP range.

Can be null.

upper

string

The upper boundary of the IP range.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

INT_EQUALS

IntEqualsCompareOperation

ParametersJSON model

The `IntEqualsCompareOperation` object

Element Type Description

negate

boolean

Element	Type	Description
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. Can be `null`.
values	integer[]	The value to compare to. If several values are specified, the OR logic applies. Can be `null`.

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

If not set, then false is used.

Can be null.

values

integer[]

The value to compare to.

If several values are specified, the OR logic applies.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

LESS_THAN

LessThanCompareOperation

ParametersJSON model

The `LessThanCompareOperation` object

Element Type Description

value

integer

Element	Type	Description
value	integer	The value to compare to. Can be `null`.

The value to compare to.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

GREATER_THAN

GreaterThanCompareOperation

ParametersJSON model

The `GreaterThanCompareOperation` object

Element Type Description

value

integer

Element	Type	Description
value	integer	The value to compare to. Can be `null`.

The value to compare to.

Can be null.

The `CompareOperation` object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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

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

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

Variations of the `TransformationBase` object

The TransformationBase object is the base for all transformation operations. The actual set of fields depends on the type of the transformation.

BEFORE

BeforeTransformation

ParametersJSON model

The `BeforeTransformation` object

Element Type Description

delimiter

string

Element	Type	Description
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. Can be `null`.

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.

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element Type Description

type

string

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 element can hold these values `AFTER` `BEFORE` `BETWEEN` `REMOVE_CREDIT_CARDS` `REMOVE_IBANS` `REMOVE_IPS` `REMOVE_NUMBERS` `REPLACE_BETWEEN` `SPLIT_SELECT` `TAKE_SEGMENTS`

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

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

AFTER

AfterTransformation

ParametersJSON model

The `AfterTransformation` object

Element Type Description

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.

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

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

BETWEEN

BetweenTransformation

ParametersJSON model

The `BetweenTransformation` object

Element Type Description

after

string

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

Can be null.

before

string

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

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

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

REPLACE_BETWEEN

ReplaceBetweenTransformation

ParametersJSON model

The `ReplaceBetweenTransformation` object

Element Type Description

after

string

The starting delimiter. The transformation replaces everything from here until ending delimiter. The delimiter itself remain intact.

Can be null.

before

string

The ending delimiter. The transformation replaces everything from starting delimiter until here. The delimiter itself remain intact.

Can be null.

replacement

string

The value to be used instead of the content between delimiters.

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

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

REMOVE_NUMBERS

RemoveNumbersTransformation

ParametersJSON model

The `RemoveNumbersTransformation` object

Element Type Description

minDigitCount

integer

Remove numbers that contain at least X digits.

Can be null.

includeHexNumbers

boolean

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

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

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

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

REMOVE_CREDIT_CARDS

RemoveCreditCardNumbersTransformation

ParametersJSON model

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

json
{
  "type": "REMOVE_CREDIT_CARDS"
}

REMOVE_IBANS

RemoveIBANsTransformation

ParametersJSON model

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

json
{
  "type": "REMOVE_IBANS"
}

REMOVE_IPS

RemoveIPsTransformation

ParametersJSON model

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

json
{
  "type": "REMOVE_IPS"
}

SPLIT_SELECT

SplitSelectTransformation

ParametersJSON model

The `SplitSelectTransformation` object

Element Type Description

delimiter

string

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

Can be null.

itemIndex

integer

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

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

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

TAKE_SEGMENTS

TakeSegmentsTransformation

ParametersJSON model

The `TakeSegmentsTransformation` object

Element Type Description

segmentCount

integer

The number of elements to be kept.

Can be null.

delimiter

string

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

Can be null.

takeFromEnd

boolean

Keeps the first (false) or last (true) elements.

If not set, then false is used, keeping the first elements.

Can be null.

The `TransformationBase` object

Configuration of transformation of the detected value.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

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

AFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS

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

Service detection API - JSON models

Variations of the ServiceDetectionRule object

FULL_WEB_REQUEST

The FullWebRequestRule object

The ConfigurationMetadata object

The ConditionsFullWebRequestAttributeTypeDto object

The CompareOperation object

The ApplicationId object

The TransformationBase object

The ContextRoot object

The ContextRootTransformation object

The ServerName object

OPAQUE_AND_EXTERNAL_WEB_REQUEST

The OpaqueAndExternalWebRequestRule object

The ConfigurationMetadata object

The ConditionsOpaqueAndExternalWebRequestAttributeTypeDto object

The CompareOperation object

The ApplicationId object

The TransformationBase object

The ContextRoot object

The ContextRootTransformation object

The Port object

The PublicDomainName object

FULL_WEB_SERVICE

The FullWebServiceRule object

The ConfigurationMetadata object

The ConditionsFullWebServiceAttributeTypeDto object

The CompareOperation object

The WebServiceName object

The TransformationBase object

The WebServiceNameSpace object

The ApplicationId object

The ContextRoot object

The ContextRootTransformation object

The ServerName object

Variations of the CompareOperation object

STRING_CONTAINS

The StringContainsCompareOperation object

The CompareOperation object

STRING_EQUALS

The StringEqualsCompareOperation object

The CompareOperation object

STARTS_WITH

The StartsWithCompareOperation object

The CompareOperation object

ENDS_WITH

The EndsWithCompareOperation object

The CompareOperation object

EXISTS

The ExistsCompareOperation object

The CompareOperation object

IP_IN_RANGE

The IpInRangeCompareOperation object

The CompareOperation object

INT_EQUALS

The IntEqualsCompareOperation object

The CompareOperation object

LESS_THAN

The LessThanCompareOperation object

The CompareOperation object

GREATER_THAN

The GreaterThanCompareOperation object

The CompareOperation object

Variations of the TransformationBase object

BEFORE

The BeforeTransformation object

The TransformationBase object

AFTER

The AfterTransformation object

The TransformationBase object

BETWEEN

The BetweenTransformation object

The TransformationBase object

REPLACE_BETWEEN

The ReplaceBetweenTransformation object

The TransformationBase object

REMOVE_NUMBERS

The RemoveNumbersTransformation object

The TransformationBase object

REMOVE_CREDIT_CARDS

Variations of the `ServiceDetectionRule` object

The `FullWebRequestRule` object

The `ConfigurationMetadata` object

The `ConditionsFullWebRequestAttributeTypeDto` object

The `CompareOperation` object

The `ApplicationId` object

The `TransformationBase` object

The `ContextRoot` object

The `ContextRootTransformation` object

The `ServerName` object

The `OpaqueAndExternalWebRequestRule` object

The `ConfigurationMetadata` object

The `ConditionsOpaqueAndExternalWebRequestAttributeTypeDto` object

The `CompareOperation` object

The `ApplicationId` object

The `TransformationBase` object

The `ContextRoot` object

The `ContextRootTransformation` object

The `Port` object

The `PublicDomainName` object

The `FullWebServiceRule` object

The `ConfigurationMetadata` object

The `ConditionsFullWebServiceAttributeTypeDto` object

The `CompareOperation` object

The `WebServiceName` object

The `TransformationBase` object

The `WebServiceNameSpace` object

The `ApplicationId` object

The `ContextRoot` object

The `ContextRootTransformation` object

The `ServerName` object

Variations of the `CompareOperation` object

The `StringContainsCompareOperation` object

The `CompareOperation` object

The `StringEqualsCompareOperation` object

The `CompareOperation` object

The `StartsWithCompareOperation` object

The `CompareOperation` object

The `EndsWithCompareOperation` object

The `CompareOperation` object

The `ExistsCompareOperation` object

The `CompareOperation` object

The `IpInRangeCompareOperation` object

The `CompareOperation` object

The `IntEqualsCompareOperation` object

The `CompareOperation` object

The `LessThanCompareOperation` object

The `CompareOperation` object

The `GreaterThanCompareOperation` object

The `CompareOperation` object

Variations of the `TransformationBase` object

The `BeforeTransformation` object

The `TransformationBase` object

The `AfterTransformation` object

The `TransformationBase` object

The `BetweenTransformation` object

The `TransformationBase` object

The `ReplaceBetweenTransformation` object

The `TransformationBase` object

The `RemoveNumbersTransformation` object

The `TransformationBase` object

The `TransformationBase` object

The `TransformationBase` object

The `TransformationBase` object

The `SplitSelectTransformation` object

The `TransformationBase` object

The `TakeSegmentsTransformation` object

The `TransformationBase` object