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.

List of services

In the selections to the left you will find all the services we provide for 1.0 of the eZ Publish REST API, with their parameters and response groups.

Content

The content resource exposed your run-of-the-mill representations of the traditional content objects and their data maps inside eZ Publish.

Content can exist in various languages. To fetch a specific translation the following query parameters can be added.

CONTENT-URI?Translation=xxx-YY

Response groups

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

For every request, a requestedResponseGroups field will be added to each response, providing every response groups that has been requested, including non-supported ones.

Geir Arne Waaler (21/01/2011 9:14 am)

Geir Arne Waaler (17/04/2012 12:11 pm)

Xiongjie Chen, Geir Arne Waaler


Comments

There are no comments.