REST API Documentation

Introduction

This document is documentation of the Curriki REST/JSON API which implements a quite complete access to the Curriki storage. The documentation has been reviewed as of Curriki 2.x in May 2011. The API is though also valid for Curriki 1.x.

Overview

Unless otherwise stated requests should simple GET or POST actions, and responses are JSON. The Curriki REST api gives access in read and write mode to assets, users, groups and metadata.

General Aspects

The entry point of most of the Curriki REST api is: http://host:port/xwiki/curriki/

The entry point of the Search of the Curriki REST api is: http://host:port/xwiki/bin/view/Search/{type}

The SVN repository for the Curriki REST api is at: http://svn.xwiki.org/host/xwiki/curriki/trunk/plugins/servlet/

A Curriki installation also exposes the XWiki REST API which is a lower level API on the data contained in a Curriki installation.

API Methods

Resources

The Curriki REST API uses the Restlet framework and exposes Resources. The Resources are routed by the Restlet Framework. The entry point of the Router is availble here: http://svn.xwiki.org/svnroot/xwiki/curriki/trunk/plugins/servlet/src/main/java/org/curriki/xwiki/servlet/restlet/router/BaseRouter.java

Tags:
Created by marcosk on 2008/12/08 16:02
    
This wiki is licensed under a Creative Commons 2.0 license
XWiki Enterprise 8.4.4-node2 - Documentation