Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

Resources

The initial set of resources exposed by the eZ Publish REST API is listed in the following sections. The output type of the REST calls is JSON-data.

Rendered HTML-output of nodes/objects is a part of the JSON-response. This is to serve a practical need when implementing clients. In many cases the best (or only) tool for the job, is to use a web-view to display data, this resource would cater for this need. This functionality will likely exploit new representation features in NEWAPI, in order to provide a unified and flexible rendering mechanism.

Accept: application/xhtml+xml / text/html
GET /api/ezp/content/node/55
 
GET /api/ezp/content/node/55.html

The fields to return should be configurable for each request. As it is almost impossible to predict what fields the web-service consumer needs to be returned, we organize them in Response Groups. They actually control the kind of information returned by the request. This concept is greatly inspired from Amazon Product Advertising API.

Each operation provides one or more default response group(s) that can be completed by one or several more response group(s) available for the operation.

CONTENT-URI?ResponseGroups=OneResponseGroup,AnotherOne

Geir Arne Waaler (14/12/2010 11:31 am)

Geir Arne Waaler (07/04/2011 8:57 am)


Comments

There are no comments.