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.

Content/list service

HTTP request for node children

GET  /[api]/ezp/v1/content/node/<nodeId>/list(/offset/<offset>/limit/<limit>/sort/<sortKey>/<sortType>)  HTTP/1.1
Host: api.example.no

Parameters

  • nodeID: Numeric. Node ID
  • offset: Numeric (optional). Starting offset. Default is 0.
  • limit: Numeric (optional). Max number of child nodes that is returned. Default is 10.
  • sortKey: String (optional). Sort attribute. Can be every non-attribute sort key supported by content/list fetch function
  • sortType: String (optional). Can be asc (default) or desc.

Note for optional parameters:

  • offset and limit are optional, but if both are wanted, they must follow the order:
    offset/<offset>/limit/<limit>
  • sortKey and sortType are optional, but if both are wanted, they must follow the order:
    sort/<sortKey>/<sortType>
  • if every parameter is wanted they must follow the order:
    offset/<offset>/limit<limit>/sort/<sortKey>/<sortType>

 

Response Groups

Metadata (default)
  • childrenCount (total children count, not the current result set count)
  • parentNodeId (reproduction of nodeID parameter)

Metadata for the children objects (type, date, etc):

  • classIdentifier
  • objectName
  • datePublished
  • dateModified
  • objectRemoteID
  • nodeRemoteID
  • objectID
  • fullURL
  • link (Link to content/node service for this node)
Fields

Value for all children fields, like in content/fields service.

Geir Arne Waaler (25/01/2011 11:26 am)

Geir Arne Waaler (02/11/2011 1:23 pm)


Comments

There are no comments.