Getting started with the HCL Compass REST API
The HCL Compass REST API allows developers to interact with HCL Compass by using HTTP based REST APIs.
To install the HCL Compass REST API, select RESTful Services from the Server Components section from the package installation page during HCL Compass installation.
- To launch the HCL Compass REST API server on Windows, run the start.bat file from the <product_install_dir>\product-rest-server-distribution\bin directory.
- To launch the HCL Compass REST API server
on Linux, perform the following steps:
- Open a shell/terminal and change directory to the <product_install_dir>/product-rest-server-distribution/bin directory.
- Setup the HCL Compass environment by
running:
source /opt/hcl/ccm/compass/cq_setup.sh
. - Start the HCL Compass REST API server by
running:
./start.sh
.
HTTP GET
is used for retrieval.HTTP POST
is used for creation.HTTP PATCH
is used for modification.HTTP DELETE
is used for deletion.
The HCL Compass REST APIs expect and provide responses in JSON format (Content-Type: application/json) unless otherwise noted.
200
for successful operation404
for record not found
This guide does not cover all available APIs. For detailed documentation for all APIs, see
https://localhost:8190/swagger-ui.html
where localhost is the
actual server name where the HCL Compass REST
API server is running.
To view the API Specification in YAML format, see
https://localhost:8190/api-docs
where localhost is the server
name where the HCL Compass REST API server is
running.