REST service for Web Content Manager

REST service for Web Content Manager

REST service for Web Content Manager is a collection of web services compliant with the Atom Publishing Protocol. Atom is an XML language used for data feeds providing access to edit access web content, including versions and workflow states, through HTTP. The service is designed according to the REpresentational State Transfer (REST) architectural style, which helps build interactive content that can be modified on the client side via a web browser. Integrated editing tools can embed HTML and JavaScript in web content components, which bind to the REST service to display or update content asynchronously using Ajax. HTTP makes integration with remote clients easier than with a traditional API. WCM functions can be visible to remote systems without adding more server-side components, such as JSP, to access Java APIs. HTTP allows these services to work seamlessly with the infrastructure including firewall, proxy servers, and caches.
For examples below that contain incomplete XML, or XML without namespace declarations, assume the following declarations have been used:

xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:app="http://www.w3.org/2007/app"
xmlns:wcm="http://www.ibm.com/xmlns/wcm"

Service entry points

The URLs, which comprise the REST service can change from release to release, or even with minor updates. Therefore, IBM recommends to never bookmark, or generate a URL unless it is for a defined entry point.

Atom publishing protocol service document /wps/mycontenthandler/model/service Contains entry points for all portal REST services. When we browse for content, we must first retrieve the service document. The AtomPub service document describes the top-level collections in an APP service. These collections represent libraries and other types of content accessible through the service. Web content queries can be stored in certain collections. This allows administrators to limit the scope and structure of queries, and bind them to specific URLs, which all authenticated users can access to retrieve the results as an Atom feed.
POC Service Looks up content URLS corresponding to POC URI, which is the ID element of Atom Entry documents
Queries /wcmrest/query Queries can be stored within the REST service or they be run directly through a single location. Security controls to prevent users from inadvertently overloading production servers with complex queries.

REST Service Access Levels

To use the REST service, for Web Content Manager a client user be assigned the "user" role or higher in the WCM REST SERVICE virtual resource. All authenticated users are assigned the "user" role by default. An administrator can edit the WCM REST SERVICE virtual resource by clicking the Administration menu icon in the toolbar, and then going to Access > Resource Permissions > Virtual Resources.

Role Description
User Work with content items and run defined queries.
Editor Work with content items and run defined queries.
Run custom queries through the following path: /wcmrest/query
Manager Work with content items and run defined queries.
Run custom queries through the following path: /wcmrest/query
Create, read, update, and delete defined queries.

Parent topic: REST service for Web Content Manager

Atom publishing protocol service document	/wps/mycontenthandler/model/service	Contains entry points for all portal REST services. When we browse for content, we must first retrieve the service document. The AtomPub service document describes the top-level collections in an APP service. These collections represent libraries and other types of content accessible through the service. Web content queries can be stored in certain collections. This allows administrators to limit the scope and structure of queries, and bind them to specific URLs, which all authenticated users can access to retrieve the results as an Atom feed.
POC Service		Looks up content URLS corresponding to POC URI, which is the ID element of Atom Entry documents
Queries	/wcmrest/query	Queries can be stored within the REST service or they be run directly through a single location. Security controls to prevent users from inadvertently overloading production servers with complex queries.

Role	Description
User	Work with content items and run defined queries.
Editor	Work with content items and run defined queries. Run custom queries through the following path: /wcmrest/query
Manager	Work with content items and run defined queries. Run custom queries through the following path: /wcmrest/query Create, read, update, and delete defined queries.