Skip to content

Getting started with the REST service for Web Content Manager V2

This topic provides information about the new APIs available from CF217 and higher.

These V2 APIs are created to complete the available actions for content and other WCM artifacts. They are either developed from scratch or created to bring their corresponding REST service for Web Content Manager V1 APIs to the V2 Swagger interface. You can find detailed information about V2 APIs at WCM REST V2 API documentation. For a comparison of V1 and V2 APIs, see Differences between V1 and V2 APIs.

If you are working with WCM via REST, it is recommended to use the WCM REST V2 API.

Note

Most of the APIs introduced in the WCM REST V2 API explorer adhere to the same API path or URI fragment structure as the WCM V1 APIs.

For the WCM REST V1 version of the APIs, refer to How to manage web content items by using REST.

APIs added or modified in CF217

Starting CF217, the WCM REST V2 Swagger API Explorer has new API additions and modifications and is also out of beta state.

WCM REST V2 Swagger API Explorer introduces new APIs corresponding to the following WCM V1 API functionalities:

  • Components like LibraryDateComponent, LibraryFileComponent, LibraryHTMLComponent, LibraryJSPComponent, LibraryLinkComponent, LibraryNumericComponent, LibraryPageNavigationComponent, LibraryTextComponent, LibraryUserNameComponent, LibraryUserSelectionComponent
  • Managed Pages
  • Projects
  • Site Area Templates
  • Workflow
  • Workflow Actions
  • Workflow Operations

APIs added or modified in CF218

Starting CF218, WCM REST V2 Swagger API Explorer introduces additional APIs. Some of these APIs are newly created while some APIs correspond to the following WCM V1 API functionalities:

  • Components like LibraryAuthoringToolsComponent, LibraryListPresentationComponent
  • Custom Workflow Actions Factory
  • Item Version Update and Restore
  • Syndication
  • Presentation Template
  • Favorite Items
  • Recent Items
  • Apply Content Templates
  • Page References
  • Rendering Content

WCM REST V2 API explorer

With WCM REST V2 API explorer, developers using the Digital Experience WCM REST APIs can explore and test all the WCM V2 APIs.

Access the WCM REST V2 API explorer located at:

http or https://host:port/dx/api/wcm/v2/explorer/

Example

https://localhost:10039/dx/api/wcm/v2/explorer/
Related information