Learn how to extend the product.
The HCL Compass REST API allows developers to interact with HCL Compass by using HTTP based REST APIs.
HCL Compass uses SSL to secure access to its user interface and REST APIs. A self signed certificate is provided out of the box, but some proxies and gateways will accept self-signed certificates.
You can install SSL certificates into HCL Compass, the HCL Compass Docker container, or into the HCL Compass Helm Chart to use with HCL SoFy.
Before making an API call, you must authenticate with the REST API server and use POST to obtain an authorization token.
Keycloak provides open source identity and access management and can be integrated with HCL Compass to help you manage your HCL Compass users.
You can use the HCL Compass REST API to interact with repositories and databases.
A Record Type describes the structure (meta4tdata) of a Record and is designed by the HCL Compass Designer.
You can use the HCL Compass REST API to Create, Delete, and Retrieve records.
You can use the HCL Compass REST API to manage queries and result sets.
Troubleshooting for various restrictions and known issues when using the HCL Compass REST API.
Webhooks serve as a communication mechanism between systems. A webhook subscribes to HCL Compass and waits. When events are triggered, HCL Compass sends information out to the subscriber.
The GitIntegration package allows the Compass REST API server to act on GitHub payloads. This allows GitHub events to be connected to records in Compass as they happen.
Learn how to use Compass CM REST API that supports both, OSLC v1 and v2.