Endpoint URIs
Endpoint URIs represent rulesets as Rule Execution Server resources for the REST execution service.
http://{host}:{port}/DecisionService/rest/v1/{rulesetpath}/{filetype}?{options}
Item | Description |
---|---|
http://{host}:{port}/DecisionService |
The endpoint and port of the hosted transparent decision service (HTDS) application. Example: http://localhost:9080/DecisionService . |
/rest |
The REST service context root. |
/v1 |
The version number of the REST service. This parameter is optional. The current version is numbered v1. If subsequent versions are released, the version number is incremented but the changes added by each version remains compatible with any code that implements the current /v1 version. |
{rulesetpath} |
The short ruleset path or the canonical ruleset path.
|
{filetype} |
The file type: wadl or openapi. |
{options} |
You can add options at the end of the URI. See Table 2 for details. |
Option | Used for | Description |
---|---|---|
format |
OpenAPI |
Select YAML or JSON. If no format is specified, YAML is used by default. Example: format=JSON |
endpoint |
OpenAPI |
It must be a valid URL. It is used to determine the host and basePath of the OpenAPI definition file. If the endpoint is not set or no value is specified, the host and basePath are retrieved from the request URL. |
schemes |
OpenAPI |
Specify HTTP or HTTPS, separated by comma. Example: schemes=HTTP, schemes=HTTPS, or schemes=HTTP,HTTPS If this parameter is not specified, the same protocol as the request URL is used. |
security |
OpenAPI |
Specify basic to enable the HTTP basic authentication. Example: security=basic |
extension |
OpenAPI |
Specify apiconnect to generate an OpenAPI file for IBM API Connect®. Example: extension=apiconnect |
trace |
OpenAPI WADL |
If it is set to true, the trace is enabled. The trace filter is added to the request and the corresponding trace is added to the response. Example: trace=true |
download |
OpenAPI WADL |
If it is set to true, the generated file is downloaded to the file system. Example: download=true |
zip |
WADL |
If it is set to true, the WADL code and its XSD files are in a compressed file. When you specify the zip option, the inline option is not necessary. Example: zip=true |
inline |
WADL |
If it is set to true, the XSD files are added in the WADL code. Example: inline=true |
http://localhost:9080/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/wadl?zip=true
http://{host}:{port}/DecisionService/rest/v1/{rulesetpath}/{filetype}?{option1}&{option2}&{option3}