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.
ServiceDetectionRule
objectThe ServiceDetectionRule
object is the base for all service detection rules. The actual set of fields depends on the type of the rule.
FullWebRequestRule
objectThe service detection rule of the FULL_WEB_REQUEST
type.
The contribution to the service ID calculation from the detected application ID.
You have two mutually exclusive options:
A list of conditions of the rule.
If several conditions are specified, the AND logic applies.
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:
You can use one or both options. If you use both, the transformation applies to the modified URL.
A short description of the rule.
The rule is enabled(true
) or disabled (false
).
The ID of the service detection rule.
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.
The name of the rule.
The order of the rule in the rules list.
The rules are evaluated from top to bottom. The first matching rule applies.
The contribution to the service ID calculation from the detected server name.
You have two mutually exclusive options:
The type of the service detection rule.
ApplicationId
objectThe contribution to the service ID calculation from the detected application ID.
You have two mutually exclusive options:
The value to be used instead of the detected value.
TransformationBase
objectConfiguration 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.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationAFTER
-> AfterTransformationBETWEEN
-> BetweenTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationSPLIT_SELECT
-> SplitSelectTransformationTAKE_SEGMENTS
-> TakeSegmentsTransformationAFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS
ConditionsFullWebRequestAttributeTypeDto
objectA condition of the service detection rule.
The type of the attribute to be checked.
APPLICATION_ID
CONTEXT_ROOT
PG_TAG
SERVER_NAME
URL_HOST_NAME
URL_PATH
A list of conditions for the rule.
If several conditions are specified, the AND logic applies.
CompareOperation
objectThe 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.
Defines the actual set of fields depending on the value. See one of the following objects:
EQUALS
-> EqualsCompareOperationSTRING_CONTAINS
-> StringContainsCompareOperationSTARTS_WITH
-> StartsWithCompareOperationENDS_WITH
-> EndsWithCompareOperationEXISTS
-> ExistsCompareOperationIP_IN_RANGE
-> IpInRangeCompareOperationLESS_THAN
-> LessThanCompareOperationGREATER_THAN
-> GreaterThanCompareOperationINT_EQUALS
-> IntEqualsCompareOperationSTRING_EQUALS
-> StringEqualsCompareOperationTAG
-> TagCompareOperationENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG
ContextRoot
objectThe 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:
You can use one or both options. If you use both, the transformation applies to the modified URL.
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.
ContextRootTransformation
objectConfiguration 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.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationBEFORE
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
ConfigurationMetadata
objectMetadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
ServerName
objectThe contribution to the service ID calculation from the detected server name.
You have two mutually exclusive options:
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.
{"type": "FULL_WEB_REQUEST","id": "f69d6702-9b6e-4c47-b94c-628acc391995","order": "1","name": "string","description": "string","enabled": true,"conditions": [{"attributeType": "URL_PATH","compareOperations": [{"type": "STRING_CONTAINS","negate": false,"ignoreCase": true,"values": ["string"]}]}],"applicationId": {"transformations": [],"valueOverride": "string"},"contextRoot": {"transformations": [{"type": "AFTER","delimiter": "string"}],"segmentsToCopyFromUrlPath": 2},"serverName": {"transformations": [{"type": "BEFORE","delimiter": "string"}]}}
OpaqueAndExternalWebRequestRule
objectThe service detection rule of the OPAQUE_AND_EXTERNAL_WEB_REQUEST
type.
The contribution to the service ID calculation from the detected application ID.
You have two mutually exclusive options:
A list of conditions of the rule.
If several conditions are specified, the AND logic applies.
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:
You can use one or both options. If you use both, the transformation applies to the modified URL.
A short description of the rule.
The rule is enabled(true
) or disabled (false
).
The ID of the service detection rule.
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.
The name of the rule.
The order of the rule in the rules list.
The rules are evaluated from top to bottom. The first matching rule applies.
The contribution to the service ID calculation from the port, where the web request has been detected.
The contribution to the service ID calculation from the domain name where the web request has been detected.
You have two mutually exclusive options:
The type of the service detection rule.
ApplicationId
objectThe contribution to the service ID calculation from the detected application ID.
You have two mutually exclusive options:
The value to be used instead of the detected value.
TransformationBase
objectConfiguration 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.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationAFTER
-> AfterTransformationBETWEEN
-> BetweenTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationSPLIT_SELECT
-> SplitSelectTransformationTAKE_SEGMENTS
-> TakeSegmentsTransformationAFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS
ConditionsOpaqueAndExternalWebRequestAttributeTypeDto
objectA condition of the service detection rule.
The type of the attribute to be checked.
IP
PG_TAG
TOP_LEVEL_DOMAIN
URL
URL_HOST_NAME
URL_PATH
URL_PORT
A list of conditions for the rule.
If several conditions are specified, the AND logic applies.
CompareOperation
objectThe 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.
Defines the actual set of fields depending on the value. See one of the following objects:
EQUALS
-> EqualsCompareOperationSTRING_CONTAINS
-> StringContainsCompareOperationSTARTS_WITH
-> StartsWithCompareOperationENDS_WITH
-> EndsWithCompareOperationEXISTS
-> ExistsCompareOperationIP_IN_RANGE
-> IpInRangeCompareOperationLESS_THAN
-> LessThanCompareOperationGREATER_THAN
-> GreaterThanCompareOperationINT_EQUALS
-> IntEqualsCompareOperationSTRING_EQUALS
-> StringEqualsCompareOperationTAG
-> TagCompareOperationENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG
ContextRoot
objectThe 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:
You can use one or both options. If you use both, the transformation applies to the modified URL.
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.
ContextRootTransformation
objectConfiguration 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.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationBEFORE
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
ConfigurationMetadata
objectMetadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
Port
objectThe contribution to the service ID calculation from the port, where the web request has been detected.
The port is used (false
) or isn't used (true
) in the service ID calculation.
PublicDomainName
objectThe contribution to the service ID calculation from the domain name where the web request has been detected.
You have two mutually exclusive options:
Use (true
) or don't use (false
) the detected host name as base for transformation.
Not applicable if the override is specified.
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.
{"type": "OPAQUE_AND_EXTERNAL_WEB_REQUEST","id": "9c22d0b1-e731-4baf-b3d0-140d14ead3c5","order": "2","name": "string","description": "string","enabled": true,"conditions": [{"attributeType": "TOP_LEVEL_DOMAIN","compareOperations": [{"type": "ENDS_WITH","negate": false,"ignoreCase": true,"values": ["string"]}]}],"applicationId": null,"contextRoot": {"transformations": [],"segmentsToCopyFromUrlPath": 1},"port": null,"publicDomainName": null}
FullWebServiceRule
objectThe 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
The contribution to the service ID calculation from the detected application ID.
You have two mutually exclusive options:
A list of conditions of the rule.
If several conditions are specified, the AND logic applies.
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:
You can use one or both options. If you use both, the transformation applies to the modified URL.
A short description of the rule.
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.
The rule is enabled(true
) or disabled (false
).
The ID of the service detection rule.
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.
The name of the rule.
The order of the rule in the rules list.
The rules are evaluated from top to bottom. The first matching rule applies.
The contribution to the service ID calculation from the detected server name.
You have two mutually exclusive options:
The type of the service detection rule.
The contribution to the service ID calculation from the detected web service name.
You have two mutually exclusive options:
The contribution to the service ID calculation from the detected web service name space.
You have two mutually exclusive options:
ApplicationId
objectThe contribution to the service ID calculation from the detected application ID.
You have two mutually exclusive options:
The value to be used instead of the detected value.
TransformationBase
objectConfiguration 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.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationAFTER
-> AfterTransformationBETWEEN
-> BetweenTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationSPLIT_SELECT
-> SplitSelectTransformationTAKE_SEGMENTS
-> TakeSegmentsTransformationAFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS
ConditionsFullWebServiceAttributeTypeDto
objectA condition of the service detection rule.
The type of the attribute to be checked.
APPLICATION_ID
CONTEXT_ROOT
FRAMEWORK
IS_SOAP_SERVICE
PG_TAG
SERVER_NAME
URL_HOST_NAME
URL_PATH
WEBSERVICE_METHOD
WEBSERVICE_NAME
WEBSERVICE_NAMESPACE
A list of conditions for the rule.
If several conditions are specified, the AND logic applies.
CompareOperation
objectThe 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.
Defines the actual set of fields depending on the value. See one of the following objects:
EQUALS
-> EqualsCompareOperationSTRING_CONTAINS
-> StringContainsCompareOperationSTARTS_WITH
-> StartsWithCompareOperationENDS_WITH
-> EndsWithCompareOperationEXISTS
-> ExistsCompareOperationIP_IN_RANGE
-> IpInRangeCompareOperationLESS_THAN
-> LessThanCompareOperationGREATER_THAN
-> GreaterThanCompareOperationINT_EQUALS
-> IntEqualsCompareOperationSTRING_EQUALS
-> StringEqualsCompareOperationTAG
-> TagCompareOperationENDS_WITH
EQUALS
EXISTS
GREATER_THAN
INT_EQUALS
IP_IN_RANGE
LESS_THAN
STARTS_WITH
STRING_CONTAINS
STRING_EQUALS
TAG
ContextRoot
objectThe 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:
You can use one or both options. If you use both, the transformation applies to the modified URL.
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.
ContextRootTransformation
objectConfiguration 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.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationBEFORE
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
ConfigurationMetadata
objectMetadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
ServerName
objectThe contribution to the service ID calculation from the detected server name.
You have two mutually exclusive options:
The value to be used instead of the detected value.
WebServiceName
objectThe contribution to the service ID calculation from the detected web service name.
You have two mutually exclusive options:
The value to be used instead of the detected value.
WebServiceNameSpace
objectThe contribution to the service ID calculation from the detected web service name space.
You have two mutually exclusive options:
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.
{"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"}]}}
CompareOperation
objectThe CompareOperation
object is the base for all comparison operations. The actual set of fields depends on the type of the comparison.
StringContainsCompareOperation
objectThe condition of the STRING_CONTAINS
type.
The condition checks whether the string value contains the specified text.
The condition is case sensitive (false
) or case insensitive (true
).
If not set, then false
is used, making the condition case sensitive.
Inverts the operation of the condition. Set to true
to turn contains into does not contain.
If not set, then false
is used.
The value to compare to.
If several values are specified, the OR logic applies.
{"type": "STRING_CONTAINS","negate": false,"ignoreCase": true,"values": ["compareValue1","compareValue2"]}
StringEqualsCompareOperation
objectThe condition of the STRING_EQUALS
type.
The condition checks whether the string value equals the specified text.
The condition is case sensitive (false
) or case insensitive (true
).
If not set, then false
is used, making the condition case sensitive.
Inverts the operation of the condition. Set to true
to turn equals into does not equal.
If not set, then false
is used.
The value to compare to.
If several values are specified, the OR logic applies.
{"type": "STRING_EQUALS","negate": false,"ignoreCase": true,"values": ["compareValue1","compareValue2"]}
StartsWithCompareOperation
objectThe condition of the STARTS_WITH
type.
The condition checks whether the string value starts with the specified text.
The condition is case sensitive (false
) or case insensitive (true
).
If not set, then false
is used, making the condition case sensitive.
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.
The value to compare to.
If several values are specified, the OR logic applies.
{"type": "STARTS_WITH","negate": false,"ignoreCase": true,"values": ["compareValue1","compareValue2"]}
EndsWithCompareOperation
objectThe condition of the ENDS_WITH
type.
The condition checks whether the string value ends with the specified text.
The condition is case sensitive (false
) or case insensitive (true
).
If not set, then false
is used, making the condition case sensitive.
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.
The value to compare to.
If several values are specified, the OR logic applies.
{"type": "ENDS_WITH","negate": false,"ignoreCase": true,"values": ["compareValue1","compareValue2"]}
ExistsCompareOperation
objectThe condition of the EXISTS
type.
The condition checks whether the specified attribute exists.
Inverts the operation of the condition. Set to true
to turn exists into does not exist.
If not set, then false
is used.
{"type": "EXISTS","negate": false}
IpInRangeCompareOperation
objectThe condition of the IP_IN_RANGE
type.
The condition checks whether the IP address belongs to a specified range.
The lower boundary of the IP range.
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.
The upper boundary of the IP range.
{"type": "IP_IN_RANGE","negate": false,"lower": "192.168.0.1","upper": "192.168.0.10"}
IntEqualsCompareOperation
objectThe condition of the INT_EQUALS
type.
The condition checks whether the integer value equals the specified value.
Inverts the operation of the condition. Set to true
to turn equals into does not equal.
If not set, then false
is used.
The value to compare to.
If several values are specified, the OR logic applies.
{"type": "INT_EQUALS","negate": false,"values": [128,258,512]}
LessThanCompareOperation
objectThe condition of the LESS_THAN
type.
The condition checks whether the integer value is less than the specified value.
The value to compare to.
{"type": "LESS_THAN","value": 512}
GreaterThanCompareOperation
objectThe condition of the GREATER_THAN
type.
The condition checks whether the integer value is greater than the specified value.
The value to compare to.
{"type": "GREATER_THAN","value": 256}
TransformationBase
objectThe TransformationBase
object is the base for all transformation operations. The actual set of fields depends on the type of the transformation.
BeforeTransformation
objectThe transformation of the BEFORE
type.
The transformation keeps the value before the specified delimiter and removes everything after it.
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.
{"type": "BEFORE","delimiter": "/"}
AfterTransformation
objectThe transformation of the AFTER
type.The transformation removes everything before the specified delimiter and keeps the value after it.
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.
{"type": "AFTER","delimiter": "/"}
BetweenTransformation
objectThe transformation of the BETWEEN
type.The transformation keeps value between the specified delimiters and removes everything outside them.
The starting delimiter. The transformation removes everything before it. The delimiter itself is not kept.
The ending delimiter. The transformation removes everything after it. The delimiter itself is not kept.
{"type": "BETWEEN","after": "support","before": "/"}
ReplaceBetweenTransformation
objectThe transformation of the REPLACE_BETWEEN
type.
The transformation replaces the content in between specified delimiters with the specified value. The rest of the string remains intact.
The starting delimiter. The transformation replaces everything from here until ending delimiter. The delimiter itself remain intact.
The ending delimiter. The transformation replaces everything from starting delimiter until here. The delimiter itself remain intact.
The value to be used instead of the content between delimiters.
{"type": "REPLACE_BETWEEN","after": "support","before": "/","replacement": "newValue"}
RemoveNumbersTransformation
objectThe transformation of the REMOVE_NUMBERS
type.
The transformation removes any numbers from the detected value.
Remove (true
) or keep (false
) hexadecimal numbers.
If not set, then false
is used, keeping hexadecimal numbers.
Remove numbers that contain at least X digits.
{"type": "REMOVE_NUMBERS","minDigitCount": 2,"includeHexNumbers": true}
RemoveCreditCardNumbersTransformation
objectThe transformation of the REMOVE_CREDIT_CARDS
type.
The transformation automatically detects and removes credit card numbers. No additional parameters needed.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationAFTER
-> AfterTransformationBETWEEN
-> BetweenTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationSPLIT_SELECT
-> SplitSelectTransformationTAKE_SEGMENTS
-> TakeSegmentsTransformationAFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS
{"type": "REMOVE_CREDIT_CARDS"}
RemoveIBANsTransformation
objectThe transformation of the REMOVE_IBANS
type.
The transformation automatically detects and removes International Bank Account Numbers (IBAN). No additional parameters needed.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationAFTER
-> AfterTransformationBETWEEN
-> BetweenTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationSPLIT_SELECT
-> SplitSelectTransformationTAKE_SEGMENTS
-> TakeSegmentsTransformationAFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS
{"type": "REMOVE_IBANS"}
RemoveIPsTransformation
objectThe transformation of the REMOVE_IPS
type.
The transformation automatically detects and removes IP addresses. No additional parameters needed.
Defines the actual set of fields depending on the value. See one of the following objects:
BEFORE
-> BeforeTransformationAFTER
-> AfterTransformationBETWEEN
-> BetweenTransformationREPLACE_BETWEEN
-> ReplaceBetweenTransformationREMOVE_NUMBERS
-> RemoveNumbersTransformationREMOVE_CREDIT_CARDS
-> RemoveCreditCardNumbersTransformationREMOVE_IBANS
-> RemoveIBANsTransformationREMOVE_IPS
-> RemoveIPsTransformationSPLIT_SELECT
-> SplitSelectTransformationTAKE_SEGMENTS
-> TakeSegmentsTransformationAFTER
BEFORE
BETWEEN
REMOVE_CREDIT_CARDS
REMOVE_IBANS
REMOVE_IPS
REMOVE_NUMBERS
REPLACE_BETWEEN
SPLIT_SELECT
TAKE_SEGMENTS
{"type": "REMOVE_IPS"}
SplitSelectTransformation
objectThe transformation of the SPLIT_SELECT
type.
The transformation splits the detected value into an array and keeps the specified element of the array.
The delimiter for splitting the detected value. The delimiter itself is not kept.
The index of the element in the split array to be used. Indexing starts with 1
.
{"type": "SPLIT_SELECT","delimiter": "/","itemIndex": 2}
TakeSegmentsTransformation
objectThe transformation of the TAKE_SEGMENTS
type.
The transformation splits the detected value into an array and keeps the specified number of first or last elements.
The delimiter for splitting the detected value. The delimiter itself is not kept.
The number of elements to be kept.
Keeps the first (false
) or last (true
) elements.
If not set, then false
is used, keeping the first elements.
{"type": "TAKE_SEGMENTS","delimiter": "/","takeFromEnd": false}