| | h1. REST API |
| | |
| | | {info}This REST API proposal is outdated. Currently we plan to cover as much of this as possible in the CMIS/AtomPub bindings, and only add our own REST API where necessary.{info} |
| | |
| | For integration in non-Java environments, one idea is to add a REST API that allows simple access to fleXive contents via HTTP. |
| | |
| | This page collects proposals for methods that should be available. The implementation will probably use the [Restlet|http://www.restlet.org/] framework. The given URIs are not final, they are just used for grouping the methods and will change in the actual implementation. |
| | |
| | The response should be an XML document, the response format will have to be determined. Contents could use a more readable version of the XML-export format. |
| | |
| | The related forum discussion can be found [here|http://forum.flexive.org/viewtopic.php?t=106]. |
| | |
| | h2. Authorization/Authentication |
| | |
| | Without authentication, any REST request has only guest user privileges. To gain more access, HTTP-Session-based authentication is provided (similar to a web application). |
| | |
| | h4. /auth/login |
| | |
| | Login the user, returns the HTTP session ID to be provided in future requests. |
| | |
| | h4. /auth/logout |
| | |
| | Performs a logout for the HTTP session. |
| | |
| | h2. Read-only access to fleXive content |
| | |
| | h4. /content |
| | |
| | Returns a content instance by PK. |
| | |
| | h4. /tree |
| | |
| | Returns the subtree identified by query parameters (e.g. node ID, node path, tree depth). |
| | |
| | h4. /tree/contents |
| | |
| | Returns the contents of a subtree (e.g. for tree-based navigation on a website). |
| | |
| | h4. /query |
| | |
| | Returns the results of a FxSQL search query. |
| | |
| | h2. Creating/editing fleXive contents |
| | |
| | h4. /content/create |
| | |
| | Create a new content, using the same XML representation as returned by /content. |
| | |
| | h4. /content/upload |
| | |
| | Convenience method for creating "binary" contents (like images, which have only one binary property). |
