Resources
The content API (ezprestapi) answers below /api/ezp/<version> (and the same below /api/ezpl/<version>). Version 1 reads; version 2 reads and writes.
- GET /content/node/<id>: one node (v1: yes, v2: yes)
- GET /content/node/<id>/list (/offset/<n>, /limit/<n>, /sort/<key>, /asc or /desc): the children (v1: yes, v2: yes)
- GET /content/node/<id>/childrenCount: the number of children (v1: yes, v2: yes)
- GET /content/node/<id>/fields: all fields (v1: yes, v2: yes)
- GET /content/node/<id>/field/<identifier>: one field (v1: yes, v2: yes)
- GET /content/object/<id>, .../fields, .../field/<identifier>: the same by object id (v1: yes, v2: yes)
- POST /content/node/create: create and publish (v1: no, v2: yes)
- POST /content/node/<id>: update (not implemented yet: 501) (v1: no, v2: yes)
- DELETE or POST /content/node/delete/<id>: remove the node's object (v1: no, v2: yes)
- GET /content/node/<id>/listAtom: Atom feed of the children; answers 500 in 6.0.15 (known issue) (v1: yes, v2: yes)
Options
- ResponseGroups (query string, comma separated) chooses the parts of an answer: for a node Metadata (default), Locations, Fields; for a list Metadata (default) and Fields; for fields FieldValues (default) and Metadata.
- OutputFormat=xhtml adds the node rendered with its rest view (see Custom output renderers).
Answers
JSON. 200, 201 for a create, 400 for a missing or unknown parameter of a create, 401 without a valid credential, 403 (access_denied) when the user may not, 404 for an unknown node. Errors have the body {"error": "<reason>", "error_message": "<text>"}.
The services one by one: List of services.
Related pages
- REST API v1 and v2, section 2
- Personal API keys, permissions of the REST interface
In this section
Contributors
- Geir Arne Waaler
- Graham Brookins Updated Maintainer
Comments
Add a comment