<
From version < 9.4 >
edited by Silvia Macovei
on 2009/10/06
To version < 9.5 >
edited by Oana Florea
on 2009/10/06
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SilviaRusu
1 +XWiki.OanaTabaranu
Content
... ... @@ -61,7 +61,7 @@
61 61  
62 62  == Interacting with the XWiki RESTful API ==
63 63  
64 -The XWiki RESTful API is accessible through HTTP so, in principle, you can use every client that is capable of "speaking" HTTP in order to interact with it, even a web browser!
64 +The XWiki RESTful API is accessible through HTTP so, in principle, you can use every client that is capable of "speaking" HTTP in order to interact with it. Even a web browser!
65 65  If you want to write more complex programs you might download an HTTP library for your favorite language (e.g., [[http://hc.apache.org/]]).
66 66  
67 67  Java users might take advantage of the [[JAXB>>https://jaxb.dev.java.net]] framework and its [[XJC binding compiler>>https://jaxb.dev.java.net/jaxb20-ea3/docs/xjc.html]] in order to generate domain object models directly from the [[XML Schema Definition>>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-rest/src/main/resources/xwiki.rest.model.xsd]], and use them for serializing and de-serializing XML representations.
... ... @@ -176,13 +176,13 @@
176 176  
177 177  In the following sections you will see that sometimes resources are created by using PUT and sometimes by using POST. The general principle is that if the client is responsible for choosing the resource URI then PUT is used. If it's the server that bears this responsibility then POST is used.
178 178  
179 -To be more clear, when a client wants to create a page it knows **where** that page should go, so it is able to communicate to the server the target URI. In this situation PUT is used.
179 +To be more clear, when a client wants to create a page it knows **where** that page should go, so it is able to communicate the server the target URI. PUT is used.
180 180  
181 -A client, on the contrary, cannot know beforehand what will be the URI of a comment, when comment URIs contains the ID of the comment and this information is generated by the server. In this case the client will do a POST and the server, in response, will communicate the URI it generated for the newly created comment.
181 +A client, on the contrary, cannot know beforehand what will be the URI of a comment, since comment URIs contains the ID of the comment and this information is generated by the server. In this case the client will do a POST and the server, in response, will communicate the URI it generated for the newly created comment.
182 182  
183 183  == XWiki RESTful API Documentation ==
184 184  
185 -In this section you will find the documentation for the whole XWiki RESTful API.
185 +In this section you will find the documentation of the whole XWiki RESTful API.
186 186  
187 187  **application/xml** representations refers to the XML Schema Definition at the following location: [[http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-rest/src/main/resources/xwiki.rest.model.xsd]]
188 188  
... ... @@ -208,10 +208,8 @@
208 208  ** **Status codes:**
209 209  *** 200: If the request was successful.
210 210  
211 -==== /wikis/{wikiName}/search?q ====
211 +==== /wikis/{wikiName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...~]&number~=n~] ====
212 212  
213 -{keywords}[[[&scope={name,content,title,objects}...]]&number=n] ====
214 -
215 215  * **HTTP Method:** GET
216 216  ** **Media types:**
217 217  *** application/xml (SearchResults element)
... ... @@ -230,10 +230,8 @@
230 230  ** **Status codes:**
231 231  *** 200: If the request was successful.
232 232  
233 -==== /wikis/{wikiName}/spaces/{spaceName}/search?q ====
231 +==== /wikis/{wikiName}/spaces/{spaceName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...~]&number~=n~] ====
234 234  
235 -{keywords}[[[&scope={name,content,title,objects}...]]&number=n] ====
236 -
237 237  * **HTTP Method:** GET
238 238  ** **Media types:**
239 239  *** application/xml (Search results element)

Get Connected