Endpoint URIs

Endpoint URIs represent rulesets as Rule Execution Server resources for the REST execution service.
URIs for REST endpoints have the following format: 
https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetpath}/{filetype}?{options}
URIs are defined as follows:
Table 1. Items that make up a URI
Item Description

https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService

The endpoint of the hosted transparent decision service (HTDS) application.

The value of <odm_on_cloud_environment> must be either dev, test, or prod.

Example: https://vhost005.bpm.ibmcloud.com/odm/dev/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.
  • A canonical ruleset path indicates the RuleApp name and version number and the ruleset name and version number. For example: myRuleApp/1.0/myRuleset/1.0
  • A short ruleset path leaves out one or both version numbers: For example: myRuleApp/myRuleset

{filetype}

The file type: wadl or openapi.

{options}

You can add options at the end of the URI. See Table 2 for details.
Table 2. Options
Option Used for Description

format

OpenAPI

Select YAML or JSON. If no format is specified, YAML is used by default.

Example: format=JSON

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.

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
Example of adding an option: 
https://vhost005.bpm.ibmcloud.com/odm/dev/DecisionService/rest/v1/miniloanruleapp/1.0/miniloanrules/1.0/wadl?zip=true
Use & when you want to add more than one option:
https://<vhostname>.bpm.ibmcloud.com/odm/<odm_on_cloud_environment>/DecisionService/rest/v1/{rulesetpath}/{filetype}?{option1}&{option2}&{option3}