wiki:S3/S3REST/Methods

S3 RESTful Methods

This page describes the standard (built-in) CRUD methods of the Eden RESTful API.

Note: CRUD methods may (and in most setups do) require access authorization.

Note: the RESTful API is extensible, therefore other methods may also be supported (e.g. /report, /summary, /profile). These methods are described in the documentation of the respective method handlers.

Note: Developers should not alter or override standard methods for any resources (although this is not strictly forbidden).

Interactive Methods

Interactive formats include: html, iframe

MethodGETPOSTPUTDELETE
resourcereturn a view of all available records in the resource (Standard: data table)submission of a form to create a new recordsee POST-
resource/<ID>return a view of a single record (update form if permitted, otherwise read-only)submission of a form to update a recordsee POSTdelete the specified record
resource/createreturn a form to create a new recordsubmission of a form to create a new recordsee POST-
resource/<ID>/readreturn a view of a single record (read-only)---
resource/<ID>/updatereturn a form to update the specified recordsubmission of a form to update a recordsee POST-
resource/deleteget a form to confirm the deletion of recordsdelete all records-see POST
resource/<ID>/deletedelete the specified recordsee GET-see GET

Transformable Formats

Transformable formats include: xml, json, s3csv

MethodGETPOSTPUTDELETE
resourceexport all (accessible) records in the specified resourcesee PUTimport records from the request body-
resource/<ID>export the specified recordsee PUTimport (update) the specified record from the request body-
resource/createreturn a resource structure description of the specified resourcesee PUTimport records from the request body-
resource/create?filename=xyz.xmlimport new records from the specified filesee PUTimport records from the request body-
resource/create?fetchurl=http://site/xyz.xmlimport new records from the specified URLsee PUTimport records from the request body-
resource/updatereturn a resource structure description of the specified resourcesee PUTimport records from the request body-
resource/update?filename=xyz.xmlimport new records from the specified filesee PUTimport records from the request body-
resource/update?fetchurl=http://site/xyz.xmlimport new records from the specified URLsee PUTimport records from the request body-
resource/<ID>/update?filename=xyz.xmlimport a record update from the specified filesee PUTimport a record update from the request body-
resource/<ID>/update?fetchurl=http://site/xyz.xmlimport a record update from the specified URLsee PUTimport a record update from the request body-
resource/readexport all (accessible) records in the specified resourcesee PUTimport records from the request body-
resource/<ID>/readexport the specified recordsee PUTimport a record update from the request body-
resource/delete---Delete all accessible records in the resource
resource/<ID>/delete---Delete the specified record

Note: in XML and JSON, data resources are always exported/imported in compound with all their subresources and referenced resources.

Example

See Example for Creating / Updating Records using PUT of an S3JSON record format: wiki:S3/S3XML#JSONFormat


DeveloperGuidelines

Last modified 7 years ago Last modified on 01/17/15 14:30:04
Note: See TracWiki for help on using the wiki.