xrow/xrowodata-ls

OData REST Interface for eZ Publish

dev-master 2015-09-17 16:14 UTC

Requires

• ezsystems/ezpublish-legacy-installer: *

GPL-2.0

• xrow GmbH

README

Installation

Active the extension. 

Useage

The service will be available over the common REST API of eZ Publish (https://www.exmaple.com/api/odata/v1/ezpublish.svc/)

Protocol Implementations

The OData Protocol is implemented as specified in http://www.odata.org/media/30002/OData.html. 

The functoinality is depending on the features set of the OData Producer fpr PHP Project.

Concrete Examples:

/folder
/folder(NodeID=2)
/folder(NodeID=2)?$skip=10
/folder(NodeID=2)?$skip=100&$top=100
/folder(NodeID=2)?$skip=10&$orderby=content_published asc
/folder(NodeID=2)?$skip=10&$orderby=content_published desc
/folder(NodeID=2)?$skip=10&$orderby=content_published%20desc&$format=json
/frontpage(NodeID=148720)/RefSetnews?$top=10&$skip=0&$orderby=content_published desc
/frontpage(NodeID=148720)/RefSetnews?$top=10&$skip=10&$orderby=content_published desc
/frontpage(NodeID=148720)/RefSetnews?$top=10&$skip=20&$orderby=content_published desc

Possible "order by" Paramenter
 - content_published
 - content_modified
 - content_state
 - section
 - priority
 - path
 - owner
 - name
 - class_name
 - class_identifier
 - depth


Abstact Example:
/[ContentClass](NodeID=[ID of Node])?$skip=[number]&$top=[number max 100]&$orderby=[number max 100 desc|asc]
How to view your data:

Use http://metasapiens.com/sesame/data-browser/preview/

or use a client SDK to access the data. 

You find an php example in extension/xrowodata/bin/test.php