Viewing the OpenAPI representation

From the REST API page, you can access the OpenApi representation of request and response elements, and their documentation.

About this task

From the REST API page, you can open and save the OpenApi file that represents the Rule Execution Server REST API and its documentation. The file uses the JSON format. You might find this format useful, for example, to read the documentation of methods and parameters.

If you want to import the JSON OpenApi code from an external tool, use this type of address:
http(s)://<host>:<port>/<RES Console context>/openapi

For example: http://localhost:9080/res/openapi

Procedure

  1. Sign in to the Rule Execution Server console as an administrator and click the REST API tab to display the REST API page.
  2. Click the View OpenAPI file button.
    You are prompted to open or save the file, save it with a JSON file extension, for example, openapi.json. The graphical user interface for this action depends on your browser.