Settings API - Service detection rules for External Web Services schema table
Service detection rules for External Web Services (builtin:service-detection.external-web-service)
Rules are evaluated from top to bottom, and the first matching rule applies. Rule conditions are evaluated before Service Id Contributors are applied. Conditions do not modify attributes of requests. If conditions match, then Service Id Contributors are applied. All of the Contributors always get applied. But it is possible to influence the creation of Services by choosing how they get transformed.
More extensive information on Service detection rules can be found here.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:service-detection.external-web-service |
| environment |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Enabled | boolean | - | required |
| name | Rule name | text | - | required |
| description | Description | text | - | optional |
| managementZones | Management zones | set | Define a management zone filter for this service detection rule. | required |
| idContributors | Service identifier contributors | idContributorsType | Contributors to the Service Identifier calculation. URL path is always applied as an Id Contributor. It is possible to exclude Port from contributing by toggling the switch off. | required |
| conditions | Conditions | list | A list of conditions necessary for the rule to take effect. If multiple conditions are specified, they all must match a Request for the rule to apply. Conditions evaluate against attributes, but do not modify them. | required |
Request body objects
The condition object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| attribute | Take the value of this attribute | text | - | required |
| compareOperationType | Apply this operation | text | - | required |
| textValues | Values | set | If multiple values are specified, at least one of them must match for the condition to match | required |
| tagValues | Values | set | If multiple values are specified, at least one of them must match for the condition to match | required |
| intValue | Value | integer | - | required |
| intValues | Values | set | - | required |
| ipRangeFrom | From | text | - | required |
| ipRangeTo | To | text | - | required |
| framework | Technology | set | - | required |
| ignoreCase | Ignore case | boolean | Ignore case sensitivity for texts. | required |
The transformation object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| transformationType | Transformation type | enum | Defines what kind of transformation will be applied on the original value. | required |
| prefix | prefix | text | - | optional |
| suffix | suffix | text | - | optional |
| replacementValue | replacement | text | - | optional |
| splitDelimiter | split by | text | - | optional |
| selectIndex | select index | integer | - | required |
| minDigitCount | min digit count | integer | - | required |
| includeHexNumbers | include hexadecimal numbers | boolean | - | required |
| segmentCount | segment count | integer | How many segments should be taken. | required |
| takeFromEnd | take from end | boolean | - | required |
The valueOverride object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| value | Value | text | - | required |
The transformationSet object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| contributionType | Contribution type | enum | Defines whether the original value should be used or if a transformation set should be used to override a value or transform it. | required |
| valueOverride | Value override | valueOverride | The value to be used instead of the detected value. | required |
| transformations | Transformations | list | Choose how the value will be transformed before contributing to the Service Id. All of the Transformations are always applied. Transformations are applied in the order they are specified, and the output of the previous transformation is the input for the next one. The resulting value contributes to the Service Id and can be found on the Service screen under Properties and tags. | required |
The serviceIdContributor object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enableIdContributor | Transform this value before letting it contribute to the Service Id | boolean | - | required |
| serviceIdContributor | - | transformationSet | - | required |
The idContributorsType object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| detectAsWebRequestService | Detect as web request service | boolean | Detect the matching requests as web request services instead of web services. This prevents detecting of matching requests as opaque web services. An opaque web request service is created instead. If you need to further modify the resulting web request service, you need to create a separate Opaque/external web request rule. | required |
| urlPath | URL path | serviceIdContributor | - | required |
| portForServiceId | Port | boolean | Let the Port contribute to the Service Id | required |