<
From version < 19.1 >
edited by Fabio Mancinelli
on 2010/01/18
To version < 20.1 >
edited by Jerome
on 2010/04/23
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.fmancinelli
1 +XWiki.jvelociter
Content
... ... @@ -1,8 +1,10 @@
1 -{{box cssClass="floatinginfobox" title="**Contents**"}}{{toc depth="2"/}}{{/box}}
1 +{{box cssClass="floatinginfobox" title="**Contents**"}}
2 +{{toc depth="2"/}}
3 +{{/box}}
2 2  
3 3  XWiki provides fine-grain access to virtually every element through an API that is based on HTTP semantics, i.e., a RESTful API. In this page you will find all the details to take advantage of this API and the instructions to use it at its full potential.
4 4  
5 -= Accessing the service=
7 += Accessing the service =
6 6  
7 7  By defaut the XWiki RESTful API entrypoint is rooted at the following URI:
8 8  
... ... @@ -14,7 +14,7 @@
14 14  
15 15  All the resource references described in the [[XWiki RESTful API Documentation>>#HXWikiRESTfulAPIDocumentation]] should be intended relative to this URL.
16 16  
17 -For example the, the ##/wikis## resources on a server running on ##localhost## on port ##8080## can be retrieved using the following URL : ##http:~//localhost:8080/xwiki/rest/wikis##
19 +For example the, the ##/wikis## resources on a server running on ##localhost## on port ##8080## can be retrieved using the following URL : ##http:~/~/localhost:8080/xwiki/rest/wikis##
18 18  
19 19  = Dataset =
20 20  
... ... @@ -69,7 +69,7 @@
69 69  
70 70  == The "HATEOAS" Graph ==
71 71  
72 -In order to better understand the relations among resources you might have a look at this [[graph>>attach:XWikiHATEOAS.pdf||]] that pictures all the resources available in the XWiki RESTful API and the relations among them. In this graph, nodes are [[URI templates>>http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.txt]] representing classes of resources. Edges are the possible links that you might find in a representation of a given resource, and their associated relations.
74 +In order to better understand the relations among resources you might have a look at this [[graph>>attach:XWikiHATEOAS.pdf]] that pictures all the resources available in the XWiki RESTful API and the relations among them. In this graph, nodes are [[URI templates>>http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.txt]] representing classes of resources. Edges are the possible links that you might find in a representation of a given resource, and their associated relations.
73 73  
74 74  This graph shows that by starting from the API entry-point a client can navigate and discover all the resources just by following the links provided in representations (and by knowing their semantics). This was exactly the way how this graph was generated.
75 75  
... ... @@ -212,7 +212,7 @@
212 212  
213 213  == Root resources ==
214 214  
215 -By defaut all the resources of the RESTful API are rooted at the following URI: ##http:~//server:port/xwiki/rest/## (depending on where your XWiki is running)
217 +By defaut all the resources of the RESTful API are rooted at the following URI: ##http:~/~/server:port/xwiki/rest/## (depending on where your XWiki is running)
216 216  
217 217  === / ===
218 218  
... ... @@ -232,7 +232,7 @@
232 232  ** **Status codes:**
233 233  *** 200: If the request was successful.
234 234  
235 -=== /wikis/{wikiName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...~]&number~=n~] ===
237 +=== /wikis/{wikiName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===
236 236  
237 237  * **HTTP Method:** GET
238 238  ** **Media types:**
... ... @@ -252,7 +252,7 @@
252 252  ** **Status codes:**
253 253  *** 200: If the request was successful.
254 254  
255 -=== /wikis/{wikiName}/spaces/{spaceName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...~]&number~=n~] ===
257 +=== /wikis/{wikiName}/spaces/{spaceName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===
256 256  
257 257  * **HTTP Method:** GET
258 258  ** **Media types:**
... ... @@ -470,7 +470,7 @@
470 470  ** **Accepted Media types:**
471 471  *** application/xml (Comment element)
472 472  *** text/plain
473 -*** application/x-www-form-urlencoded (allowed field names: text)
475 +*** application/x-www-form-urlencoded - allowed field names: ##text##, ##replyTo## (object number of the replied comment, since XE 2.3)
474 474  ** **Media types:**
475 475  *** application/xml (Comment element)
476 476  ** **Description:** Create a comment on the given page.

Get Connected