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.
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.
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:
- 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.
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:
- 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.
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.
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.
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-> TakeSegmentsTransformation
AFTERBEFOREBETWEENREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEENSPLIT_SELECTTAKE_SEGMENTS
The ConditionsFullWebRequestAttributeTypeDto object
A condition of the service detection rule.
The type of the attribute to be checked.
APPLICATION_IDCONTEXT_ROOTPG_TAGSERVER_NAMEURL_HOST_NAMEURL_PATH
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.
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-> TagCompareOperation
ENDS_WITHEQUALSEXISTSGREATER_THANINT_EQUALSIP_IN_RANGELESS_THANSTARTS_WITHSTRING_CONTAINSSTRING_EQUALSTAG
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.
The number of segments of the URL to be kept.
The URL is divided by slashes (/), the indexing starts with 1 at context root.
For example, if you specify 2 for the www.dynatrace.com/support/help/dynatrace-api/ URL, the value of support/help is used.
The ContextRootTransformation object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type of the transformation.
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-> RemoveIPsTransformation
BEFOREREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEEN
The ConfigurationMetadata object
Metadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
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.
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"}]}}
OPAQUE_AND_EXTERNAL_WEB_REQUEST
The OpaqueAndExternalWebRequestRule object
The 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:
- 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.
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:
- 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.
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:
- 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.
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.
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.
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-> TakeSegmentsTransformation
AFTERBEFOREBETWEENREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEENSPLIT_SELECTTAKE_SEGMENTS
The ConditionsOpaqueAndExternalWebRequestAttributeTypeDto object
A condition of the service detection rule.
The type of the attribute to be checked.
IPPG_TAGTOP_LEVEL_DOMAINURLURL_HOST_NAMEURL_PATHURL_PORT
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.
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-> TagCompareOperation
ENDS_WITHEQUALSEXISTSGREATER_THANINT_EQUALSIP_IN_RANGELESS_THANSTARTS_WITHSTRING_CONTAINSSTRING_EQUALSTAG
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.
The number of segments of the URL to be kept.
The URL is divided by slashes (/), the indexing starts with 1 at context root.
For example, if you specify 2 for the www.dynatrace.com/support/help/dynatrace-api/ URL, the value of support/help is used.
The ContextRootTransformation object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type of the transformation.
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-> RemoveIPsTransformation
BEFOREREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEEN
The ConfigurationMetadata object
Metadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
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.
The port is used (false) or isn't used (true) in the service ID calculation.
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.
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}
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:
AXISCXFHESSIANJAX_WS_RIJBOSSJERSEYPROGRESSRESTEASYRESTLETSPRINGTIBCOWEBLOGICWEBMETHODSWEBSPHEREWINK
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.
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:
- 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.
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:
- 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.
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:
- 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.
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.
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.
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.
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-> TakeSegmentsTransformation
AFTERBEFOREBETWEENREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEENSPLIT_SELECTTAKE_SEGMENTS
The ConditionsFullWebServiceAttributeTypeDto object
A condition of the service detection rule.
The type of the attribute to be checked.
APPLICATION_IDCONTEXT_ROOTFRAMEWORKIS_SOAP_SERVICEPG_TAGSERVER_NAMEURL_HOST_NAMEURL_PATHWEBSERVICE_METHODWEBSERVICE_NAMEWEBSERVICE_NAMESPACE
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.
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-> TagCompareOperation
ENDS_WITHEQUALSEXISTSGREATER_THANINT_EQUALSIP_IN_RANGELESS_THANSTARTS_WITHSTRING_CONTAINSSTRING_EQUALSTAG
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.
The number of segments of the URL to be kept.
The URL is divided by slashes (/), the indexing starts with 1 at context root.
For example, if you specify 2 for the www.dynatrace.com/support/help/dynatrace-api/ URL, the value of support/help is used.
The ContextRootTransformation object
Configuration of transformation of the detected value.
If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.
The actual set of fields depends on the type of the transformation.
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-> RemoveIPsTransformation
BEFOREREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEEN
The ConfigurationMetadata object
Metadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
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.
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.
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.
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"}]}}
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 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"]}
STRING_EQUALS
The StringEqualsCompareOperation object
The 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"]}
STARTS_WITH
The StartsWithCompareOperation object
The 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"]}
ENDS_WITH
The EndsWithCompareOperation object
The 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"]}
EXISTS
The ExistsCompareOperation object
The 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}
IP_IN_RANGE
The IpInRangeCompareOperation object
The 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"}
INT_EQUALS
The IntEqualsCompareOperation object
The 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]}
LESS_THAN
The LessThanCompareOperation object
The 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}
GREATER_THAN
The GreaterThanCompareOperation object
The 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}
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
The 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": "/"}
AFTER
The AfterTransformation object
The 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": "/"}
BETWEEN
The BetweenTransformation object
The 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": "/"}
REPLACE_BETWEEN
The ReplaceBetweenTransformation object
The 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"}
REMOVE_NUMBERS
The RemoveNumbersTransformation object
The 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}
REMOVE_CREDIT_CARDS
The RemoveCreditCardNumbersTransformation object
The 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-> TakeSegmentsTransformation
AFTERBEFOREBETWEENREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEENSPLIT_SELECTTAKE_SEGMENTS
{"type": "REMOVE_CREDIT_CARDS"}
REMOVE_IBANS
The RemoveIBANsTransformation object
The 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-> TakeSegmentsTransformation
AFTERBEFOREBETWEENREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEENSPLIT_SELECTTAKE_SEGMENTS
{"type": "REMOVE_IBANS"}
REMOVE_IPS
The RemoveIPsTransformation object
The 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-> TakeSegmentsTransformation
AFTERBEFOREBETWEENREMOVE_CREDIT_CARDSREMOVE_IBANSREMOVE_IPSREMOVE_NUMBERSREPLACE_BETWEENSPLIT_SELECTTAKE_SEGMENTS
{"type": "REMOVE_IPS"}
SPLIT_SELECT
The SplitSelectTransformation object
The 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}
TAKE_SEGMENTS
The TakeSegmentsTransformation object
The 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}