REST API Explorers
Developers can accelerate development tasks using the following explorers provided for REST APIs available for use with HCL Digital Experience (DX) deployments to on premises platforms, and HCL DX 9.5 deployments to supported Kubernetes container platforms. You can initiate and test transactions or other capabilities such as content delivery using the API explorers.
This section shows the DX REST API explorers available for use with deployments to on-premises and container platforms. The following tables list the APIs and the URLs. Note that the URLs are relative, and you can append these URLs to your host name.
| API name | URL | Description | Additional information |
|---|---|---|---|
| Access Control API | /dx/api/access/v1/explorer |
Shows the developer entry points to Access Control Management. | Atom XML format. See Portal Access Control REST API for more information. |
| Digital Asset Management API | /dx/api/dam/v1/explorer |
Shows the developer entry points to the Digital Asset Management features of HCL DX 9.5. | JSON format. |
| Image-processor API | /dx/api/image-processor/v1/explorer |
Shows the developer entry points to the Digital Asset Management Image Processor functions of HCL DX 9.5. | JSON format. |
| People Service API | /dx/api/people/v1/explorer |
Shows the developer entry points to the People Service API features of HCL DX 9.5. | JSON format. See People Service API for more information. |
| Personalization API | /dx/api/pzn/v1/explorer |
Shows the developer entry points to the Personalization rules. | JSON format. See HCL Digital Experience Personalization for more information. |
| Remote Model API | /dx/api/remotemodel/v1/explorer |
Shows the developer entry points to the various models for pages, layouts, and more. | Atom XML format. Support for more endpoints are planned in upcoming releases. See Digital Experience Portal Remote Model REST API Explorer for more information. |
| Ring API | /dx/api/core/v1/explorer |
Shows the developer entry points to the Core services like user management authentication and WCM through JSON. | JSON format. See the HCL Experience API Help Center topic for more information. |
| Search API | /dx/api/search/v1/explorer |
Shows the developer entry points to search (like text or keyword searches). | Atom XML format. See Search REST API specification for more information. |
| Search V2 API | /dx/api/search/v2/explorer |
Shows the developer entry points to the new OpenSearch-powered search implementation that includes push capabilities. | JSON format. See Configuring the Search V2 backend for more information. |
| Users and Groups API | /dx/api/users/v1/explorer |
Shows the developer entry points to the users and groups. | Atom XML format. See Remote REST service for PUMA for more information. |
| WCM API | /dx/api/wcm/v2/explorer |
Shows the updated set of entry points to the Web Content Manager (WCM). | JSON format. See REST service for Web Content Manager for information about V1 APIs. The V2 APIs are available and out of beta starting CF217. See Getting started with the REST service for Web Content Manager V2 for more information. |