Decision service URL patterns

This topic contains runtime URL patterns that are used in Rule Execution Server.

You use these patterns in Rule Execution Server:
  • REST pattern: https://<host>:<port>/<AppContextRoot>/DecisionService/rest/<rs_path>
  • SOAP pattern: https://<host>:<port>/<AppContextRoot>/DecisionService/ws/<rs_path>
  • Swagger UI pattern: https://<host>:<port>/<AppContextRoot>/DecisionService/swagger?<SwaggerUIParams>
  • Test pattern: https://<host>:<port>/<AppContextRoot>/DecisionService/run?<TestParams>
The following properties are used in the patterns:
  • /rest/ represents the REST API.
  • /run? is used for testing rulesets in the Rule Execution Server console.
  • /swagger? is used to access the Swagger UI interface.
  • /ws/ represents the SOAP API.
Note: In the patterns, run replaces run.jsp. URLs that use run.jsp are still supported. However, this support might be removed in future versions of the product.
Protecting runtime decision services with basic authentication can be achieved based on these URL patterns.

The ruleset testing feature is accessible through the ruleset view page in the Rule Execution Server console:
  1. Click Retrieve HTDS Description File.
  2. Select REST.
  3. Click Test.
Remember: The ruleset testing feature is not available for the SOAP API.
See the following examples when these URL patterns are developed:
  • https://app.example.com:9443/odm/test/DecisionService/rest/loans/1.0/miniloan/1.0
  • https://app.example.com:9443/odm/test/DecisionService/run?path=/loans/1.0/miniloan/1.0&trace=false&type=WADL&kind=native
  • https://app.example.com:9443/odm/test/DecisionService/swagger?path/loans/1.0/miniloan/1.0&trace=true
  • https://app.example.com:9443/odm/test/DecisionService/ws/loans/1.0/miniloan/1.0
The following example shows a complete URL format with a version:
https://<host>:<port>/<AppContextRoot>/DecisionService/rest/v1/<rs_path>
Table 1 explains each item in the URL format:
Table 1. Items in the URL patterns
Item Name Description
<host>:<port> Hostname and port number You can also configure the server to remove the port number (use a default port number).

Example: app.example.com:9443
<AppContextRoot> Application context root You can specify one to provide a clearer path. It can be the product name, such as odm, followed by the environment name, such as test.

Example: odm/test
DecisionService Operational Decision Manager decision service DecisionService is always part of the URL.
rest, ws, run, or swagger Fixed part to specify REST, SOAP, testing ruleset URL, or Swagger UI URL Followed by a ruleset path, appended in the path or provided as a parameter.
v1 API version The latest version of the API.
<rs_path> Ruleset path A valid ruleset path corresponding to a deployed ruleset.

Example: /myRuleapp/1.0/myRuleset/2.0
<TestParams> URL query parameters that apply to the test page (/run) These parameters are populated when navigating from the Rule Execution Server console.
<SwaggerUIParams> URL query parameters that apply to the Swagger UI interface (/swagger) These parameters are populated when navigating from the Rule Execution Server console.