Digital Experience REST API explorers
Developers can accelerate development tasks using the following explorers provided for REST APIs available for use with HCL Digital Experience deployments to on premises platforms, and HCL Digital Experience 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 |
---|---|---|---|
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. |
Ring API | /dx/api/core/v1/explorer | Shows the developer entry points to the Core services like user management authentication and WCM via JSON. | JSON format. See the HCL Experience API Help Center topic for more information. |
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. |
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 the Portal Access Control REST API Help Center topic for more information. |
Personalization API | /dx/api/pzn/v1/explorer | Shows the developer entry points to the Personalization rules. | JSON format. Currently in beta stage as support for more rules
are added. See the HCL Digital Experience Personalization Help Center topic for more information. |
Remote Model API | /dx/api/remotemodel/v1/explorer | Shows the develop entry points to the various models for pages, layouts, and more. | Atom XML format. Support for more endpoints are planned in
upcoming releases. See the Digital Experience Portal Remote Model REST API Explorer 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 the Search REST API specification Help Center topic 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 the Remote REST service for PUMA Help Center topic 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. Currently in beta stage as support for more WCM
artifacts are added. See the REST service for Web Content Manager Help Center topic for more information. |
Limitations
- As of HCL DX 9.5 CF 205, Ring API now strictly enforces the case on query
parameters. The following table shows values that were not strictly enforced
previously:
GET Endpoints Query Parameters /webcontent/components sort
/webcontent/content-templates sort
/webcontent/contents sort
/webcontent/workflow-actions sort
/webcontent/favorite-items sort
/webcontent/libraries sort
/webcontent/site-areas sort
/webcontent/Workflows sort
/webcontent/workflow-stages sort
/webcontent/recent-items type
,sort
/webcontent/search type
,sort
,depth
,state
,project state