Testing a ruleset for REST execution

From the Rule Execution Server console, you test REST API requests for execution of a ruleset in XML or in JSON format.

Before you begin

Restriction:
  • Browser compatibility: The test feature is not supported by Internet Explorer 8 and earlier versions. If you work with Internet Explorer 9 or 10, make sure that the Tools > Compatibility View command is deactivated.
  • Generation of OpenAPI description files is supported for only Java™ XOMs, while WSDL and WADL file generation are supported for XML XOMs and Java XOMs with JAXB annotations.

About this task

Before you execute a ruleset in XML or in JSON form from a client, you can test your execution request in the Rule Execution Server console.
Tip: You can also test the execution of a ruleset without generating it as a hosted transparent decision service.

Procedure

  1. Select a ruleset and open the Ruleset View.
  2. Click Retrieve HTDS description file.
  3. Select REST in the Service protocol type section.
  4. Select WADL, OpenAPI - YAML, or OpenAPI - JSON from the Format pull-down menu as explained in Viewing or downloading an HTDS description file.
    Note: You can select OpenAPI - YAML and OpenAPI - JSON only for Java XOMs.
  5. Click Test.

    The execution request is displayed in a separate browser window.

    If you selected WADL in the previous step, you can choose XML or JSON for Java XOMs as an execution format from the Execution Request drop-down menu. For XML XOMs, you have XML as an execution format.

    If you selected OpenAPI, you have only one execution format: JSON.

  6. Click Execute Request.

    The response is displayed in the Server Response frame. If you selected Decision trace information before you click Test, the trace filter is added to the request and the decision trace is included in the response.

  7. Optional: If you selected XML as an execution format, click the Validate XML icon.Validate XML icon to validate the generated XML code.
    Note: The JSON format does not support validation.
    If the request is invalid, an error message indicates the reason and location of the failure. A red dot is displayed next to the incorrect line in the request.
  8. Optional: Use the Undo and Redo icons to erase or restore what you type in the text areas.