Navigation
eZ Documentation Center
 

This is outdated documentation made for eZ Publish Platform 5.1. It is being moved into the eZ Publish 5.x documentation, so please go there for most up-to-date documentation.

Skip to end of metadata
Go to start of metadata

The complete reference of the REST API resources can be found in the specifications: https://github.com/ezsystems/ezpublish-kernel/blob/master/doc/specifications/rest/REST-API-V2.rst. This file is actually more up-to-date than this documentation, as it is used as a development spec / reference. One problem is that it references the whole API, which isn't actually completely implemented. Some resources are still being worked on, but you should have most of what you need.

A better overview of the real status will be added to this documentation soon.

Documentation structure

Resources are grouped by chapters: Content, Content Types and User. In each of those chapters, you will first get an overview of the chapter, with a two dimensions table crossing every resource with every HTTP verb, and giving you a summary of the action.

Then throughout the chapter, grouped into sub-chapters, detailed documentation for every resource, with:

  • The resource string
  • The HTTP verb with override, if applicable
  • A description of what this resource does
  • Which headers are supported, and how to use them
  • Which error codes can occur
  • Most of the time, a request + response example

 

  • No labels