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
The FullWebRequestRule
object
The service detection rule of the FULL_WEB_REQUEST
type.
Element | Type | Description |
---|---|---|
applicationId | Application | The contribution to the service ID calculation from the detected application ID. You have two mutually exclusive options:
|
conditions | Conditions | A list of conditions of the rule. If several conditions are specified, the AND logic applies. |
contextRoot | Context | 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 You have two options:
You can use one or both options. If you use both, the transformation applies to the modified URL. |
description | string | A short description of the rule. |
enabled | boolean | The rule is enabled( |
id | string | The ID of the service detection rule. |
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. |
metadata | Configuration | Metadata useful for debugging |
name | string | The name of the rule. |
order | string | The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies. |
serverName | Server | The contribution to the service ID calculation from the detected server name. You have two mutually exclusive options:
|
type | string | The type of the service detection rule. |
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 | Transformation | Transformations to be applied to the detected value. |
valueOverride | string | The value to be used instead of the detected value. |
The TransformationBase
object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type of the transformation. 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:
The element can hold these values
|
The ConditionsFullWebRequestAttributeTypeDto
object
A condition of the service detection rule.
Element | Type | Description |
---|---|---|
attributeType | string | The type of the attribute to be checked. The element can hold these values
|
compareOperations | Compare | A list of conditions for the rule. If several conditions are specified, the AND logic applies. |
The CompareOperation
object
The condition of the rule.
The actual set of fields depends on the type of the condition. 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:
The element can hold these values
|
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 |
---|---|---|
segmentsToCopyFromUrlPath | integer | The number of segments of the URL to be kept. The URL is divided by slashes ( For example, if you specify |
transformations | Context | Transformations to be applied to the detected value. |
The ContextRootTransformation
object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type
of the transformation.
Element | Type | Description |
---|---|---|
type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
The ConfigurationMetadata
object
Metadata useful for debugging
Element | Type | Description |
---|---|---|
clusterVersion | string | Dynatrace version. |
configurationVersions | integer[] | A sorted list of the version numbers of the configuration. |
currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. |
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 | Transformation | Transformations to be applied to the detected value. |
valueOverride | string | The value to be used instead of the detected value. |
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
The OpaqueAndExternalWebRequestRule
object
The service detection rule of the OPAQUE_AND_EXTERNAL_WEB_REQUEST
type.
Element | Type | Description |
---|---|---|
applicationId | Application | The contribution to the service ID calculation from the detected application ID. You have two mutually exclusive options:
|
conditions | Conditions | A list of conditions of the rule. If several conditions are specified, the AND logic applies. |
contextRoot | Context | 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 You have two options:
You can use one or both options. If you use both, the transformation applies to the modified URL. |
description | string | A short description of the rule. |
enabled | boolean | The rule is enabled( |
id | string | The ID of the service detection rule. |
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. |
metadata | Configuration | Metadata useful for debugging |
name | string | The name of the rule. |
order | string | The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies. |
port | Port | The contribution to the service ID calculation from the port, where the web request has been detected. |
publicDomainName | Public | The contribution to the service ID calculation from the domain name where the web request has been detected. You have two mutually exclusive options:
|
type | string | The type of the service detection rule. |
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 | Transformation | Transformations to be applied to the detected value. |
valueOverride | string | The value to be used instead of the detected value. |
The TransformationBase
object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type of the transformation. 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:
The element can hold these values
|
The ConditionsOpaqueAndExternalWebRequestAttributeTypeDto
object
A condition of the service detection rule.
Element | Type | Description |
---|---|---|
attributeType | string | The type of the attribute to be checked. The element can hold these values
|
compareOperations | Compare | A list of conditions for the rule. If several conditions are specified, the AND logic applies. |
The CompareOperation
object
The condition of the rule.
The actual set of fields depends on the type of the condition. 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:
The element can hold these values
|
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 |
---|---|---|
segmentsToCopyFromUrlPath | integer | The number of segments of the URL to be kept. The URL is divided by slashes ( For example, if you specify |
transformations | Context | Transformations to be applied to the detected value. |
The ContextRootTransformation
object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type
of the transformation.
Element | Type | Description |
---|---|---|
type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
The ConfigurationMetadata
object
Metadata useful for debugging
Element | Type | Description |
---|---|---|
clusterVersion | string | Dynatrace version. |
configurationVersions | integer[] | A sorted list of the version numbers of the configuration. |
currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. |
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 | The port is used ( |
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 |
---|---|---|
copyFromHostName | boolean | Use ( Not applicable if the override is specified. |
transformations | Transformation | Transformations to be applied to the detected value. |
valueOverride | string | The value to be used instead of the detected value. |
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
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 |
---|---|---|
applicationId | Application | The contribution to the service ID calculation from the detected application ID. You have two mutually exclusive options:
|
conditions | Conditions | A list of conditions of the rule. If several conditions are specified, the AND logic applies. |
contextRoot | Context | 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 You have two options:
You can use one or both options. If you use both, the transformation applies to the modified URL. |
description | string | A short description of the rule. |
detectAsWebRequestService | boolean | Detect the matching requests as full web services ( Setting this field to Default is |
enabled | boolean | The rule is enabled( |
id | string | The ID of the service detection rule. |
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. |
metadata | Configuration | Metadata useful for debugging |
name | string | The name of the rule. |
order | string | The order of the rule in the rules list. The rules are evaluated from top to bottom. The first matching rule applies. |
serverName | Server | The contribution to the service ID calculation from the detected server name. You have two mutually exclusive options:
|
type | string | The type of the service detection rule. |
webServiceName | Web | The contribution to the service ID calculation from the detected web service name. You have two mutually exclusive options:
|
webServiceNameSpace | Web | The contribution to the service ID calculation from the detected web service name space. You have two mutually exclusive options:
|
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 | Transformation | Transformations to be applied to the detected value. |
valueOverride | string | The value to be used instead of the detected value. |
The TransformationBase
object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type of the transformation. 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:
The element can hold these values
|
The ConditionsFullWebServiceAttributeTypeDto
object
A condition of the service detection rule.
Element | Type | Description |
---|---|---|
attributeType | string | The type of the attribute to be checked. The element can hold these values
|
compareOperations | Compare | A list of conditions for the rule. If several conditions are specified, the AND logic applies. |
The CompareOperation
object
The condition of the rule.
The actual set of fields depends on the type of the condition. 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:
The element can hold these values
|
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 |
---|---|---|
segmentsToCopyFromUrlPath | integer | The number of segments of the URL to be kept. The URL is divided by slashes ( For example, if you specify |
transformations | Context | Transformations to be applied to the detected value. |
The ContextRootTransformation
object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type
of the transformation.
Element | Type | Description |
---|---|---|
type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
The ConfigurationMetadata
object
Metadata useful for debugging
Element | Type | Description |
---|---|---|
clusterVersion | string | Dynatrace version. |
configurationVersions | integer[] | A sorted list of the version numbers of the configuration. |
currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. |
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 | Transformation | Transformations to be applied to the detected value. |
valueOverride | string | The value to be used instead of the detected value. |
The WebServiceName
object
The contribution to the service ID calculation from the detected web service name.
You have two mutually exclusive options:
- Override the detected value with a specified static value. Specify the new value in the valueOverride field.
- Dynamically transform the detected value. Specify the transformation parameters in the transformations field.
Element | Type | Description |
---|---|---|
transformations | Transformation | Transformations to be applied to the detected value. |
valueOverride | string | The value to be used instead of the detected value. |
The WebServiceNameSpace
object
The contribution to the service ID calculation from the detected web service name space.
You have two mutually exclusive options:
- Override the detected value with a specified static value. Specify the new value in the valueOverride field.
- Dynamically transform the detected value. Specify the transformation parameters in the transformations field.
Element | Type | Description |
---|---|---|
transformations | Transformation | Transformations to be applied to the detected value. |
valueOverride | string | The value to be used instead of the detected value. |
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
The StringContainsCompareOperation
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 |
---|---|---|
ignoreCase | boolean | The condition is case sensitive ( If not set, then |
negate | boolean | Inverts the operation of the condition. Set to If not set, then |
values | string[] | The value to compare to. If several values are specified, the OR logic applies. |
json{
"type": "STRING_CONTAINS",
"negate": false,
"ignoreCase": true,
"values": [
"compareValue1",
"compareValue2"
]
}
STRING_EQUALS
The StringEqualsCompareOperation
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 |
---|---|---|
ignoreCase | boolean | The condition is case sensitive ( If not set, then |
negate | boolean | Inverts the operation of the condition. Set to If not set, then |
values | string[] | The value to compare to. If several values are specified, the OR logic applies. |
json{
"type": "STRING_EQUALS",
"negate": false,
"ignoreCase": true,
"values": [
"compareValue1",
"compareValue2"
]
}
STARTS_WITH
The StartsWithCompareOperation
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 |
---|---|---|
ignoreCase | boolean | The condition is case sensitive ( If not set, then |
negate | boolean | Inverts the operation of the condition. Set to If not set, then |
values | string[] | The value to compare to. If several values are specified, the OR logic applies. |
json{
"type": "STARTS_WITH",
"negate": false,
"ignoreCase": true,
"values": [
"compareValue1",
"compareValue2"
]
}
ENDS_WITH
The EndsWithCompareOperation
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 |
---|---|---|
ignoreCase | boolean | The condition is case sensitive ( If not set, then |
negate | boolean | Inverts the operation of the condition. Set to If not set, then |
values | string[] | The value to compare to. If several values are specified, the OR logic applies. |
json{
"type": "ENDS_WITH",
"negate": false,
"ignoreCase": true,
"values": [
"compareValue1",
"compareValue2"
]
}
EXISTS
The ExistsCompareOperation
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 |
---|---|---|
negate | boolean | Inverts the operation of the condition. Set to If not set, then |
json{
"type": "EXISTS",
"negate": false
}
IP_IN_RANGE
The IpInRangeCompareOperation
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 |
---|---|---|
lower | string | The lower boundary of the IP range. |
negate | boolean | Inverts the operation of the condition. Set to If not set, then |
upper | string | The upper boundary of the IP range. |
json{
"type": "IP_IN_RANGE",
"negate": false,
"lower": "192.168.0.1",
"upper": "192.168.0.10"
}
INT_EQUALS
The IntEqualsCompareOperation
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 |
---|---|---|
negate | boolean | Inverts the operation of the condition. Set to If not set, then |
values | integer[] | The value to compare to. If several values are specified, the OR logic applies. |
json{
"type": "INT_EQUALS",
"negate": false,
"values": [
128,
258,
512
]
}
LESS_THAN
The LessThanCompareOperation
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 |
---|---|---|
value | integer | The value to compare to. |
json{
"type": "LESS_THAN",
"value": 512
}
GREATER_THAN
The GreaterThanCompareOperation
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 |
---|---|---|
value | integer | The value to compare to. |
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
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. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.
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. |
json{
"type": "BEFORE",
"delimiter": "/"
}
AFTER
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. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.
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. |
json{
"type": "AFTER",
"delimiter": "/"
}
BETWEEN
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. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.
Element | Type | Description |
---|---|---|
after | string | The starting delimiter. The transformation removes everything before it. The delimiter itself is not kept. |
before | string | The ending delimiter. The transformation removes everything after it. The delimiter itself is not kept. |
json{
"type": "BETWEEN",
"after": "support",
"before": "/"
}
REPLACE_BETWEEN
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. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.
Element | Type | Description |
---|---|---|
after | string | The starting delimiter. The transformation replaces everything from here until ending delimiter. The delimiter itself remain intact. |
before | string | The ending delimiter. The transformation replaces everything from starting delimiter until here. The delimiter itself remain intact. |
replacement | string | The value to be used instead of the content between delimiters. |
json{
"type": "REPLACE_BETWEEN",
"after": "support",
"before": "/",
"replacement": "newValue"
}
REMOVE_NUMBERS
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. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.
Element | Type | Description |
---|---|---|
includeHexNumbers | boolean | Remove ( If not set, then |
minDigitCount | integer | Remove numbers that contain at least X digits. |
json{
"type": "REMOVE_NUMBERS",
"minDigitCount": 2,
"includeHexNumbers": true
}
REMOVE_CREDIT_CARDS
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. 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:
The element can hold these values
|
json{
"type": "REMOVE_CREDIT_CARDS"
}
REMOVE_IBANS
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. 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:
The element can hold these values
|
json{
"type": "REMOVE_IBANS"
}
REMOVE_IPS
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. 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:
The element can hold these values
|
json{
"type": "REMOVE_IPS"
}
SPLIT_SELECT
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. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.
Element | Type | Description |
---|---|---|
delimiter | string | The delimiter for splitting the detected value. The delimiter itself is not kept. |
itemIndex | integer | The index of the element in the split array to be used. Indexing starts with |
json{
"type": "SPLIT_SELECT",
"delimiter": "/",
"itemIndex": 2
}
TAKE_SEGMENTS
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. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.
Element | Type | Description |
---|---|---|
delimiter | string | The delimiter for splitting the detected value. The delimiter itself is not kept. |
segmentCount | integer | The number of elements to be kept. |
takeFromEnd | boolean | Keeps the first ( If not set, then |
json{
"type": "TAKE_SEGMENTS",
"delimiter": "/",
"takeFromEnd": false
}