REST service for Web Content Manager v3
The HCL Digital Experience (DX) Web Content Manager (WCM) API v3 provides REST access to WCM content, libraries, site areas, categories, taxonomies, and presentation templates. Built on Java API for RESTful Web Services (JAX-RS) 2.1 and Java Platform, Enterprise Edition (Java EE) 8 standards, it offers simplified JSON payloads and standard HTTP operations.
Features
- Deploy REST APIs compliant with JAX-RS 2.1 and Java EE 8.
- Generate API documentation automatically using OpenAPI 3.0 specifications.
- Process simplified JSON payloads without nested Atom format complexity.
- Optimize HTTP operations using ETags, JSON Merge Patch (RFC 7396), and sparse fieldsets.
- Test endpoints interactively using the API Explorer.
Prerequisites
- HCL DX Compose Cumulative Fix (CF) 238 or a later version is installed in the target environment.
- A Kubernetes cluster is running an active Helm deployment.
- Administrative access is available to edit and apply the Helm values.yaml configuration file.
- The WebEngine container service is running and operational.
Documentation
- Enabling and disabling Web Content Manager REST API v3
Learn how to enable and disable the WCM REST API v3. - Configuring Web Content Manager REST API v3
Learn how to enable, configure, and start using the WCM REST v3 APIs, including authentication methods and basic usage examples. - Using Web Content Manager REST API v3
Learn how to interact with WCM resources, execute queries, and apply best practices when using WCM REST API v3 endpoints.
HCLSoftware U learning materials
Note
Access HCLSoftware U resources for free. Log in or Sign up to get started. If you have further questions, Contact us or check the FAQ.
For an introduction to the WCM V3 API, go to the What’s New in DX CF238 interactive lesson.