REST API Syntax and Examples

These topics document the syntax of REST requests supported by the HCL OneDB™ REST API.

Each HCL OneDB REST API jar file comes bundled with its own OpenAPI documentation of the REST API included in that jar file. You can access the OpenAPI documentation for your REST server by accessing http://<hostname>:<port>/openapi in your browser, where <hostname> and <port> reflect the host and port where you are running the REST API. For example, you might find your OpenAPI documentation at http://localhost:8080/openapi.

You can find an online version of this documentation here: REST API documentation for OneDB.