Wiki source code of The XWiki RESTful API

Version 44.1 by Guillaume Delhumeau on 2015/07/09
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc depth="2"/}}
3 {{/box}}
4
5 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.
6
7 = Accessing the service =
8
9 By defaut the XWiki RESTful API entrypoint is rooted at the following URI:
10
11 {{code}}
12
13 http://host:port/xwiki/rest
14
15 {{/code}}
16
17 All the resource references described in the [[XWiki RESTful API Documentation>>#HXWikiRESTfulAPIDocumentation]] should be intended relative to this URL.
18
19 For example 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##
20
21 In addition to retrieving content in XML format, you can also retrieve it in JSON format by adding the parameter ##?media=json## in the URL. For example: ##http:~/~/localhost:8080/xwiki/rest/wikis?media=json##
22
23 = Dataset =
24
25 This section contains a brief and high-level description of the XWiki data set that should serve as a basis for presenting resources and their associated operations.
26
27 XWiki has **pages** organized in **spaces**. Each **page** is available in multiple **versions** (its **history**) and **translations**. Translated pages have their own **versions** and **history** which are independent. Each page might have **attachments**. Each attachment has its own **history**. Attachments are shared among all the different translations of a page (i.e., the same set of attachments is the same regardless of the page language). Pages can have one or more **objects**. Objects are instances of a **class** that contains a set of **properties**. Some objects might be directly exposed as first class entities, such as **comments** and **tags**. Objects, as attachments, are shared among all page translations.
28
29 = Understanding resources and representations =
30
31 "An important concept in REST is the existence of resources (sources of specific information), each of which is referenced with a global identifier (e.g., an URI in HTTP). In order to manipulate these resources, components of the network (user agents and origin servers) communicate via a standardized interface (e.g., HTTP) and exchange representations of these resources (the actual documents conveying the information)." ([[Wikipedia>>http://en.wikipedia.org/wiki/Representational_State_Transfer#Central_principle]])
32
33 Resources in XWiki are pages, attachments, objects, properties, spaces, and all the //things// we described in the previous section. XWiki has a default way of conveying the information about these resources, i.e., by providing well defined XML representations that contain all the information associated to the resource in an XML format. This format is described using an [[XML Schema Definition file>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-rest/xwiki-platform-rest-model/src/main/resources/xwiki.rest.model.xsd]].
34
35 Of course the same resource can be represented in many different ways. This is yet to be documented.
36
37 Another important aspect of representations is that they contain useful information for linking related resources. This is a realization of the //Hypermedia As The Engine Of The Application State (HATEOAS)// principle. In XML representations this information is conveyed through the ##<link>## tag. This tag has two important parameters: **rel** and **href**. **rel** specifies the "semantics" of the link, while **href** is the URI of the linked resource.
38
39 For example, in the representation of a page, we can have links to the comments, tags, attachments which are independent resources associated to the current page. These links are provided in the XML representation of a page and allow a client to navigate to related resources... Like we do every day when we click on a link in a web page.
40
41 [[image:representation||height="430"]]
42
43 == Relations ==
44
45 The available relations that you might find in the XML resource representations are the following:
46
47 |=Rel|=Semantics
48 |{{{http://www.xwiki.org/rel/wikis}}}|The representation containing the list of virtual wikis.
49 |{{{http://www.xwiki.org/rel/spaces}}}|The representation containing the list of spaces in a wiki.
50 |{{{http://www.xwiki.org/rel/pages}}}|The representation containing the list of pages in a space.
51 |{{{http://www.xwiki.org/rel/translation}}}|The representation containing a translation of a page.
52 |{{{http://www.xwiki.org/rel/page}}}|The representation for a page.
53 |{{{http://www.xwiki.org/rel/space}}}|The representation for a space.
54 |{{{http://www.xwiki.org/rel/parent}}}|The representation for the page that is parent of the current resource.
55 |{{{http://www.xwiki.org/rel/home}}}|The representation for the page that is the home of the current resource.
56 |{{{http://www.xwiki.org/rel/attachmentData}}}|The representation of the actual attachment data.
57 |{{{http://www.xwiki.org/rel/comments}}}|The representation of the list of comments associated to the current resource.
58 |{{{http://www.xwiki.org/rel/attachments}}}|The representation of the list of attachments associated to the current resource.
59 |{{{http://www.xwiki.org/rel/objects}}}|The representation of the list of objects associated to the current resource.
60 |{{{http://www.xwiki.org/rel/object}}}|The representation for an object.
61 |{{{http://www.xwiki.org/rel/classes}}}|The representation of the list of classes associated to the current resource.
62 |{{{http://www.xwiki.org/rel/history}}}|The representation of the list of history information associated to the current resource.
63 |{{{http://www.xwiki.org/rel/class}}}|The representation for a class.
64 |{{{http://www.xwiki.org/rel/property}}}|The representation for a property.
65 |{{{http://www.xwiki.org/rel/properties}}}|The representation of the list of properties associated to the current resource.
66 |{{{http://www.xwiki.org/rel/modifications}}}|The representation of the list of modifications associated to the current resource.
67 |{{{http://www.xwiki.org/rel/children}}}|The representation of the list of children associated to the current resource.
68 |{{{http://www.xwiki.org/rel/tags}}}|The representation of the list of tags associated to the current resource.
69 |{{{http://www.xwiki.org/rel/tag}}}|The representation of a tag.
70 |{{{http://www.xwiki.org/rel/search}}}|The representation for a search resource.
71 |{{{http://www.xwiki.org/rel/syntaxes}}}|The representation for a syntax resource.
72
73 Relations are defined as URIs in order to provide a sort of namespace. Currently these URIs are not links to real web pages but, in the future, they might point to descriptions of their semantics on actual web pages (or other kinds of representations).
74
75 == The "HATEOAS" Graph ==
76
77 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://code.google.com/p/uri-templates/]] representing classes of resources. Edges are the possible links that you might find in a representation of a given resource, and their associated relations.
78
79 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.
80
81 = Interacting with the XWiki RESTful API =
82
83 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!
84 If you want to write more complex programs you might download an HTTP library for your favorite language (e.g., [[http://hc.apache.org/]]).
85
86 Java users might take advantage of the [[JAXB>>http://jaxb.java.net/]] framework and its [[XJC binding compiler>>http://jaxb.java.net/2.2.4/docs/xjc.html]] in order to generate domain object models directly from the [[XML Schema Definition>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-rest/xwiki-platform-rest-model/src/main/resources/xwiki.rest.model.xsd]], and use them for serializing and de-serializing XML representations.
87
88 If you use this approach (Apache HTTP Client + JAXB) you will find yourself writing some code like this:
89
90 {{code language="java"}}
91 import javax.xml.bind.JAXBContext;
92 import javax.xml.bind.Unmarshaller;
93
94 import org.apache.commons.httpclient.HttpClient;
95 import org.apache.commons.httpclient.methods.GetMethod;
96 import org.xwiki.rest.model.jaxb.Page;
97
98 ...
99 HttpClient httpClient = new HttpClient();
100 JAXBContext context = JAXBContext.newInstance("org.xwiki.rest.model.jaxb");
101 Unmarshaller unmarshaller = context.createUnmarshaller();
102
103 GetMethod getMethod = new GetMethod("http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome");
104 getMethod.addRequestHeader("Accept", "application/xml");
105 httpClient.executeMethod(getMethod);
106
107 Page page = (Page) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
108 {{/code}}
109
110 And you will have all the information about the Main.WebHome page in the Page object, without the need of handling XML directly.
111
112 Because of the wide variety of HTTP frameworks available we don't provide a full tutorial about using them. However, in order to show you how to interact with the XWiki RESTful API, we will use [[curl>>http://curl.haxx.se]]: a standard command line HTTP client that provides an interface to all the functionalities of the HTTP protocol.
113
114 By using curl, the previous example would have been:
115
116 {{code language="xml"}}
117 $ curl http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome
118 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
119 <page xmlns="http://www.xwiki.org">
120 <link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
121 ...
122 {{/code}}
123
124 == Authentication ==
125
126 The XWiki RESTful API supports two types of authentication:
127
128 * **HTTP BASIC Auth**: You provide your credentials using the Authorization HTTP header
129 * **XWiki session**: If you are logged in XWiki and you use the cookies provided by the authentication mechanism, you will also be authenticated to the XWiki RESTful API. This is useful, for example, when you are interacting with the API using the XMLHttpRequest object of a browser using Javascript.
130
131 If you don't provide any credentials the XWiki RESTful API will recognize you as a XWiki.Guest user.
132
133 So if you have, let's say a Main.PrivatePage, and you try to do:
134
135 {{code language="none"}}
136 $ curl -v http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/PrivatePage
137 ...
138 < HTTP/1.1 401 Unauthorized
139 ...
140 {{/code}}
141
142 You will get an Unauthorized empty response.
143
144 On the contrary, by specifying Admin credentials you gain access to the actual page:
145
146 {{code language="xml"}}
147 $ curl -u Admin:admin http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/PrivatePage
148 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
149 <page xmlns="http://www.xwiki.org">
150 <link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
151 ...
152 <content>Only admin can see this</content>
153 </page>
154 {{/code}}
155
156 == Sending representations ==
157
158 Many resources are modifiable, so you can send representations in order to change the state of those resources (e.g., pages).
159 All modifiable resources accept XML representations that conform to the [[XML Schema Definition>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-rest/xwiki-platform-rest-model/src/main/resources/xwiki.rest.model.xsd]]. However, some other representations might be accepted as well (see the following sections).
160
161 Resource update is usually done by using the PUT method, while resource creation is done via PUT or POST.
162
163 For example, in order to create a page you might do the following:
164
165 {{code language="xml"}}
166 $ curl -u Admin:admin -X PUT --data-binary "@newpage.xml" -H "Content-Type: application/xml" http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/NewPage
167 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
168 <page xmlns="http://www.xwiki.org">
169 <link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
170 ...
171 <version>1.1</version>
172 <majorVersion>1</majorVersion>
173 <minorVersion>1</minorVersion>
174 <created>2009-03-21+01:00</created>
175 <creator>XWiki.Admin</creator>
176 <modified>2009-03-21+01:00</modified>
177 <modifier>XWiki.Admin</modifier>
178 <content>This is a new page</content>
179 </page>
180 {{/code}}
181
182 Where newpage.xml is an XML file containing
183
184 {{code language="xml"}}
185 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
186 <page xmlns="http://www.xwiki.org">
187 <title>Hello world</title>
188 <syntax>xwiki/2.0</syntax>
189 <content>This is a new page</content>
190 </page>
191 {{/code}}
192
193 The page has been created and is accessible. Subsequent PUT requests to the page URI will modify its content.
194
195 You can specify a subset of the three elements {{{title}}}, {{{syntax}}}, and {{{content}}} in the XML when updating/creating a page.
196 For example, if you just want to change the title, it is sufficient to specify only the {{{title}}} element. The current content and the syntax of the page will be left unchanged.
197
198 == Overcoming browser limitations ==
199
200 As said before, it could be useful to send information by using browser's XmlHttpRequest objects. However, currently many browsers only support GET and POST methods, so it is impossible to send, for example, PUT requests. In order to overcome this limitation you can override the HTTP Method by specifying a ##method## parameter in the URI query string.
201
202 In the previous example, if you send a POST request to the ##http:~/~/localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/NewPage?method=PUT## it will be interpreted as if it were an actual PUT request.
203
204 This overriding mechanism allows the interaction with the XWiki RESTful API by using any kind of browser.
205
206 == PUT vs POST ==
207
208 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.
209
210 To be clearer, 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.
211
212 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.
213
214 = XWiki RESTful API Documentation =
215
216 In this section you will find the documentation of the whole XWiki RESTful API.
217
218 **application/xml** representations refers to the [[XML Schema Definition>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-rest/xwiki-platform-rest-model/src/main/resources/xwiki.rest.model.xsd]].
219
220 Resource URIs are specified using [[URI templates>>http://code.google.com/p/uri-templates/]]. Bracketed elements are formal parameters and should be instantiated to actual values in order to retrieve the associated resource.
221
222 == Root resources ==
223
224 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)
225
226 === / ===
227
228 * **HTTP Method:** GET
229 ** **Media types:**
230 *** application/xml (XWiki element)
231 ** **Description:** Retrieves the entry root description containing information about the server (currently returns the XWiki product Version).
232 ** **Status codes:**
233 *** 200: If the request was successful.
234
235 === /syntaxes ===
236
237 * **HTTP Method:** GET
238 ** **Media types:**
239 *** application/xml (Syntaxes element)
240 ** **Description:** The list of syntaxes supported by the XWiki instance.
241 ** **Status codes:**
242 *** 200: If the request was successful.
243
244 === /wikis ===
245
246 * **HTTP Method:** GET
247 ** **Media types:**
248 *** application/xml (Wikis element)
249 ** **Description:** The list of wikis available on the XWiki instance. Unless the wiki is configured to be a wiki farm, this list is usually made of a single element 'xwiki'.
250 ** **Status codes:**
251 *** 200: If the request was successful.
252
253 === /wikis/query?q~={query}&wikis~=wikiList[&distinct~={true,false}][&order~={asc,desc}][&start~=n][&number~=n][&prettyNames~={true,false}][&className~=className] ===
254
255 * **HTTP Method:** GET
256 ** **Media types:**
257 *** application/xml (SearchResults element)
258 ** **Description:** Search resources (pages and attachments):
259 *** [since 6.4] using a SOLR query (handled by the [[SOLR Query module>>extensions:Extension.Solr Search Query API]]) on the wikis that are specified as a comma separated list in the //wikis// parameter. If //className// is specified, the result will also contain the data for the first object of the corresponding class.
260 *** [before 6.4] using a Lucene query (handled by the [[Lucene Plugin>>extensions:Extension.Lucene Plugin]]) on the wikis that are specified as a comma separated list in the //wikis// parameter. If //className// is specified, the result will also contain the data for the first object of the corresponding class.
261 ** **Status codes:**
262 *** 200: If the request was successful.
263
264 === /wikis/{wikiName} ===
265
266 * **HTTP Method:** GET
267 ** **Media types:**
268 *** application/xml (Wiki element)
269 ** **Description:** information about the wiki
270 ** **Status codes:**
271 *** 200: If the request was successful.
272
273 * **HTTP Method:** POST
274 ** **Accepted Media types:**
275 *** octet/stream (A XAR file)
276 ** **Media types:**
277 *** application/xml (Wiki element)
278 ** **Query parameters**
279 *** backup={true/false} - import XAR as a backup XAR
280 *** history={RESET/REPLACE/ADD} - history importing
281 ** **Description:** import a XAR in a wiki.
282 ** **Status codes:**
283 *** 200: If the request was successful.
284
285 === /wikis/{wikiName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&start~=n][&number~=n][&orderField~=field&order~={asc,desc}][distinct~={true,false}][&prettyNames~={true,false}] ===
286
287 * **HTTP Method:** GET
288 ** **Media types:**
289 *** application/xml (SearchResults element)
290 ** **Description:** The list of pages and objects that contain the {keywords} in the specified {scope}s. Multiple scopes can be specified. Search results are relative to the whole {wikiName}
291 ** **Status codes:**
292 *** 200: If the request was successful.
293
294 === /wikis/{wikiName}/query?q~={query}&type~={hql,xwql,lucene,solr}[&distinct~={true,false}]~~[&order~={asc,desc}][&start~=n][&number~=n][&prettyNames~={true,false}][&className~=className] ===
295
296 * **HTTP Method:** GET
297 ** **Media types:**
298 *** application/xml (SearchResults element)
299 ** **Description:** Allow to execute HQL, XWQL, Lucene or SOLR queries on the given {wikiName}. The //q// parameter contains the corresponding query. See [[HQL Query Examples in Velocity>>platform:DevGuide.velocityHqlExamples]], [[XWiki Query Language Specification>>dev:Design.XWiki Query Language Specification]], [[Lucene Plugin>>extensions:Extension.Lucene Plugin]] and [[SOLR query API>>extensions:Extension.Solr Search Query API]] examples of the queries that can be specified in this parameter. If //className// is specified, the result will also contain the data for the first object of the corresponding class.
300 ** **Status codes:**
301 *** 200: If the request was successful.
302
303 === /wikimanager (This resource is only available when using XWiki Enterprise Manager) ===
304
305 * **HTTP Method:** POST
306 ** **Accepted Media types:**
307 *** application/xml (Wiki element)
308 ** **Media types:**
309 *** application/xml (Wiki element)
310 ** **Query parameters**
311 *** template - the wiki template to be used for initializing the wiki.
312 *** history={RESET/REPLACE/ADD} - history importing
313 ** **Description:** create a new wiki.
314 ** **Status codes:**
315 *** 200: If the request was successful.
316
317 == Space resources ==
318
319 === /wikis/{wikiName}/spaces[?start~=offset&number~=n] ===
320
321 * **HTTP Method:** GET
322 ** **Media types:**
323 *** application/xml (Spaces element)
324 ** **Description:** Retrieves the list of spaces available in the {wikiName} wiki.
325 ** **Status codes:**
326 *** 200: If the request was successful.
327
328 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===
329
330 * **HTTP Method:** GET
331 ** **Media types:**
332 *** application/xml (Search results element)
333 ** **Description:** The list of pages and objects that contain the {keywords} in the specified {scope}s. Multiple scopes can be specified. Search results are relative to space {spaceName}
334 ** **Status codes:**
335 *** 200: If the request was successful.
336 *** 401: If the user is not authorized.
337
338 == Page resources ==
339
340 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages[?start~=offset&number~=n] ===
341
342 * **HTTP Method:** GET
343 ** **Media types:**
344 *** application/xml (Pages element)
345 ** **Description:** The list of pages in the space {spaceName}
346 ** **Status codes:**
347 *** 200: If the request was successful.
348 *** 401: If the user is not authorized.
349
350 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName} ===
351
352 * **HTTP Method:** GET
353 ** **Media types:**
354 *** application/xml (Page element)
355 ** **Description:**
356 ** **Status codes:**
357 *** 200: If the request was successful.
358 *** 401: If the user is not authorized.
359
360 \\
361
362 * **HTTP Method:** PUT
363 ** **Accepted Media types:**
364 *** application/xml (Page element)
365 *** text/plain (Only page content)
366 *** application/x-www-form-urlencoded (allowed field names: title, parent, content)
367 ** **Media types:**
368 *** application/xml (Page element)
369 ** **Description:** Create or updates a page.
370 ** **Status codes:**
371 *** 201: If the page was created.
372 *** 202: If the page was updated.
373 *** 304: If the page was not modified.
374 *** 401: If the user is not authorized.
375
376 \\
377
378 * **HTTP Method:** DELETE
379 ** **Media types:**
380 *** application/xml (Page element)
381 ** **Description:** Delete the page.
382 ** **Status codes:**
383 *** 204: If the request was successful.
384 *** 401: If the user is not authorized.
385
386 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history[?start~=offset&number~=n] ===
387
388 * **HTTP Method:** GET
389 ** **Media types:**
390 *** application/xml (History element)
391 ** **Description:** The list of all the versions of the given page.
392 ** **Status codes:**
393 *** 200: If the request was successful.
394 *** 401: If the user is not authorized.
395
396 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version} ===
397
398 * **HTTP Method:** GET
399 ** **Media types:**
400 *** application/xml (Page element)
401 ** **Description:** The page at version {version}
402 ** **Status codes:**
403 *** 200: If the request was successful.
404 *** 401: If the user is not authorized.
405
406 ==== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/translations[?start~=offset&number~=n] ====
407
408 * **HTTP Method:** GET
409 ** **Media types:**
410 *** application/xml (Translations element)
411 ** **Description:** The list of available translation for the page
412 ** **Status codes:**
413 *** 200: If the request was successful.
414 *** 401: If the user is not authorized.
415
416 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/translations/{language} ===
417
418 * **HTTP Method:** GET
419 ** **Media types:**
420 *** application/xml (Page element)
421 ** **Description:** The page at in the given {language}.
422 ** **Status codes:**
423 *** 200: If the request was successful.
424 *** 401: If the user is not authorized.
425
426 \\
427
428 * **HTTP Method:** PUT
429 ** **Accepted Media types:**
430 *** application/xml (Page element)
431 *** text/plain (Only page content)
432 *** application/x-www-form-urlencoded (allowed field names: title, parent, content)
433 ** **Media types:**
434 *** application/xml (Page element)
435 ** **Description:** Create or updates a page translation.
436 ** **Status codes:**
437 *** 201: If the page was created.
438 *** 202: If the page was updated.
439 *** 304: If the page was not modified.
440 *** 401: If the user is not authorized.
441
442 \\
443
444 * **HTTP Method:** DELETE
445 ** **Media types:**
446 *** application/xml (Page element)
447 ** **Description:** Delete the page translation.
448 ** **Status codes:**
449 *** 204: If the request was successful.
450 *** 401: If the user is not authorized.
451
452 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/translations/{language}/history ===
453
454 * **HTTP Method:** GET
455 ** **Media types:**
456 *** application/xml (History element)
457 ** **Description:** The list of all the available revisions of the page in a given {language}.
458 ** **Status codes:**
459 *** 200: If the request was successful.
460 *** 401: If the user is not authorized.
461
462 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/translations/{lang}/history/{version} ===
463
464 * **HTTP Method:** GET
465 ** **Media types:**
466 *** application/xml (Page element)
467 ** **Description:** A page at a given {version} in a given {language}.
468 ** **Status codes:**
469 *** 200: If the request was successful.
470 *** 401: If the user is not authorized.
471
472 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/children ===
473
474 * **HTTP Method:** GET
475 ** **Media types:**
476 *** application/xml (Pages element)
477 ** **Description:** The list of the children of a given page.
478 ** **Status codes:**
479 *** 200: If the request was successful.
480 *** 401: If the user is not authorized.
481
482 === /wikis/{wikiName}/pages[?name~=paneName&space~=spaceName&author~=authorName] ===
483
484 * **HTTP Method:** GET
485 ** **Media types:**
486 *** application/xml (Pages element)
487 ** **Description:** The list of pages in the wiki {wikiName}. Filters can be set for the name, space and/or author to include only pages that match the given filters. This resource can be used to search for pages in a wiki.
488 ** **Status codes:**
489 *** 200: If the request was successful.
490 *** 401: If the user is not authorized.
491
492 == Tag resources ==
493
494 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/tags ===
495
496 * **HTTP Method:** GET
497 ** **Media types:**
498 *** application/xml (Tags element)
499 ** **Description:** List page tags.
500 ** **Status codes:**
501 *** 200: If the request was successful.
502 *** 401: If the user is not authorized.
503
504 \\
505
506 * **HTTP Method:** PUT
507 ** **Accepted Media types:**
508 *** application/xml (Tag element)
509 *** text/plain
510 *** application/x-www-form-urlencoded (allowed field names: tag)
511 ** **Media types:**
512 *** application/xml (Tags element)
513 ** **Description:** Add a tag to the page.
514 ** **Status codes:**
515 *** 202: If the request was successful.
516 *** 401: If the user is not authorized.
517
518 === /wikis/{wikiName}/tags ===
519
520 * **HTTP Method:** GET
521 ** **Media types:**
522 *** application/xml (Tags element)
523 ** **Description:** The list of all available tags
524 ** **Status codes:**
525 *** 200: If the request was successful.
526 *** 401: If the user is not authorized.
527
528 === /wikis/{wikiName}/tags/{tag1}[,{tag2},{tag3}...][?start~=offset&number~=n] ===
529
530 * **HTTP Method:** GET
531 ** **Media types:**
532 *** application/xml (Pages element)
533 ** **Description:** The list of pages having the specified tags.
534 ** **Status codes:**
535 *** 200: If the request was successful.
536 *** 401: If the user is not authorized.
537
538 == Comments resources ==
539
540 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/comments[?start~=offset&number~=n] ===
541
542 * **HTTP Method:** GET
543 ** **Media types:**
544 *** application/xml (Comments element)
545 ** **Description:** The list of comments on a given page.
546 ** **Status codes:**
547 *** 200: If the request was successful.
548 *** 401: If the user is not authorized.
549
550 \\
551
552 * **HTTP Method:** POST
553 ** **Accepted Media types:**
554 *** application/xml (Comment element)
555 *** text/plain
556 *** application/x-www-form-urlencoded - allowed field names: ##text##, ##replyTo## (object number of the replied comment, since XE 2.3)
557 ** **Media types:**
558 *** application/xml (Comment element)
559 ** **Description:** Create a comment on the given page.
560 ** **Status codes:**
561 *** 201: If the comment was created. (The Location header will contain the URI where the comment has been created.)
562 *** 401: If the user is not authorized.
563
564 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/comments/{commentId} ===
565
566 * **HTTP Method:** GET
567 ** **Media types:**
568 *** application/xml (Comment element)
569 ** **Description:** A specific comment on a page
570 ** **Status codes:**
571 *** 200: If the request was successful.
572 *** 401: If the user is not authorized.
573
574 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/comments ===
575
576 * **HTTP Method:** GET
577 ** **Media types:**
578 *** application/xml (Comments element)
579 ** **Description:** The list of comments at a specific page {version}.
580 ** **Status codes:**
581 *** 200: If the request was successful.
582 *** 401: If the user is not authorized.
583
584 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/comments/{commentId} ===
585
586 * **HTTP Method:** GET
587 ** **Media types:**
588 *** application/xml (Comment element)
589 ** **Description:** A comment at a specific page {version}.
590 ** **Status codes:**
591 *** 200: If the request was successful.
592 *** 401: If the user is not authorized.
593
594 == Attachments resources ==
595
596 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/attachments[?start~=offset&number~=n] ===
597
598 * **HTTP Method:** GET
599 ** **Media types:**
600 *** application/xml (Attachments element)
601 ** **Description:** The list of attachments of a given page.
602 ** **Status codes:**
603 *** 200: If the request was successful.
604 *** 401: If the user is not authorized.
605
606 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/attachments/{attachmentName} ===
607
608 * **HTTP Method:** GET
609 ** **Media types:**
610 *** The same of the attachment media type.
611 ** **Description:** The attachment identified by {attachmentName} on a given page.
612 ** **Status codes:**
613 *** 200: If the request was successful.
614 *** 401: If the user is not authorized.
615
616 \\
617
618 * **HTTP Method:** PUT
619 ** **Accepted media types:**
620 *** **/**
621 ** **Media types:**
622 *** application/xml (AttachmentSummary element)
623 ** **Description:** Create an attachment identified by {attachmentName} on a given page.
624 ** **Status codes:**
625 *** 201: If the attachment was created.
626 *** 202: If the attachment was updated.
627 *** 401: If the user is not authorized.
628
629 \\
630
631 * **HTTP Method:** DELETE
632 ** **Media types:**
633 ** **Description:** Delete the attachment identified by {attachmentName} on a given page.
634 ** **Status codes:**
635 *** 204: If the attachment was deleted.
636 *** 401: If the user is not authorized.
637
638 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/attachments[?start~=offset&number~=n] ===
639
640 * **HTTP Method:** GET
641 ** **Media types:**
642 *** application/xml (Attachments element)
643 ** **Description:** The list of attachments at a given page {version}.
644 ** **Status codes:**
645 *** 200: If the request was successful.
646 *** 401: If the user is not authorized.
647
648 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/attachments/{attachmentName} ===
649
650 * **HTTP Method:** GET
651 ** **Media types:**
652 *** The same of the attachment media type.
653 ** **Description:** The attachment identified by {attachmentName} on a given page {version}.
654 ** **Status codes:**
655 *** 200: If the request was successful.
656 *** 401: If the user is not authorized.
657
658 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/attachments/{attachmentName}/history ===
659
660 * **HTTP Method:** GET
661 ** **Media types:**
662 *** application/xml (Attachments element)
663 ** **Description:** The list of available version for the {attachmentName}
664 ** **Status codes:**
665 *** 200: If the request was successful.
666 *** 401: If the user is not authorized.
667
668 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/attachments/{attachmentName}/history/{version} ===
669
670 * **HTTP Method:** GET
671 ** **Media types:**
672 *** The same of the attachment media type.
673 ** **Description:** The {attachmentName} at a given {version}
674 ** **Status codes:**
675 *** 200: If the request was successful.
676 *** 401: If the user is not authorized.
677
678 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/attachments[?name~=attachmentName&page~=pageName&author~=authorName&types~=attachmentTypeList&start~=offset&number~=n] ===
679
680 * **HTTP Method:** GET
681 ** **Media types:**
682 *** application/xml (Attachments element)
683 ** **Description:** The list of attachments of pages located in a given {spaceName}. Filters can be set for the name, page, author and/or types (comma separated list of strings) to include only attachments that match the given filters. This resource can be used to search for attachments in a space.
684 ** **Status codes:**
685 *** 200: If the request was successful.
686 *** 401: If the user is not authorized.
687
688 === /wikis/{wikiName}/attachments[?name~=attachmentName&page~=pageName&space~=spaceName&author~=authorName&types~=attachmentTypeList&start~=offset&number~=n] ===
689
690 * **HTTP Method:** GET
691 ** **Media types:**
692 *** application/xml (Attachments element)
693 ** **Description:** The list of attachments in a given {wikiName}. Filters can be set for the name, page, space, author and/or type (comma separated list of strings) to include only attachments that match the given filters. This resource can be used to search for attachments in a wiki.
694 ** **Status codes:**
695 *** 200: If the request was successful.
696 *** 401: If the user is not authorized.
697
698 == Object resources ==
699
700 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects[?start~=offset&number~=n] ===
701
702 * **HTTP Method:** GET
703 ** **Media types:**
704 *** application/xml (Objects element)
705 ** **Description:** The list of objects associated to a page.
706 ** **Status codes:**
707 *** 200: If the request was successful.
708 *** 401: If the user is not authorized.
709
710 \\
711
712 * **HTTP Method:** POST
713 ** **Accepted media types:**
714 *** application/xml (Object element)
715 *** application/x-www-form-urlencoded (a set of property#name=value pairs representing properties and a field className)
716 ** **Media types:**
717 *** application/xml (Object element)
718 ** **Description:** Create a new object.
719 ** **Status codes:**
720 *** 201: If the object was created (The Location header will contain the URI associated to the newly created object).
721 *** 401: If the user is not authorized.
722
723 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects/{className}[?start~=offset&number~=n] ===
724
725 * **HTTP Method:** GET
726 ** **Media types:**
727 *** application/xml (Objects element)
728 ** **Description:** The list of objects of a given {className} associated to a page.
729 ** **Status codes:**
730 *** 200: If the request was successful.
731 *** 401: If the user is not authorized.
732
733 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects/{className}/{objectNumber} ===
734
735 * **HTTP Method:** GET
736 ** **Media types:**
737 *** application/xml (Object element)
738 ** **Description:** The object of type {className} identified by {objectNumber} associated to the given page.
739 ** **Status codes:**
740 *** 200: If the request was successful.
741 *** 401: If the user is not authorized.
742
743 \\
744
745 * **HTTP Method:** PUT
746 ** **Accepted media types:**
747 *** application/xml (Object element)
748 *** application/x-www-form-urlencoded (a set of property#name=value pairs representing properties)
749 ** **Media types:**
750 *** application/xml (Object element)
751 ** **Description:** Modify the object properties.
752 ** **Status codes:**
753 *** 202: If the object was updated.
754 *** 401: If the user is not authorized.
755
756 \\
757
758 * **HTTP Method:** DELETE
759 ** **Media types:**
760 ** **Description:** Delete the object.
761 ** **Status codes:**
762 *** 204: If the object was deleted.
763 *** 401: If the user is not authorized.
764
765 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects/{className}/{objectNumber}/properties ===
766
767 * **HTTP Method:** GET
768 ** **Media types:**
769 *** application/xml (Properties element)
770 ** **Description:** The properties of the object of type {className} identified by {objectNumber} associated to the given page.
771 ** **Status codes:**
772 *** 200: If the request was successful.
773 *** 401: If the user is not authorized.
774
775 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects/{className}/{objectNumber}/properties/{propertyName} ===
776
777 * **HTTP Method:** GET
778 ** **Media types:**
779 *** application/xml (Properties element)
780 ** **Description:** The property {propertyname} of the object of type {className} identified by {objectNumber} associated to the given page.
781 ** **Status codes:**
782 *** 200: If the request was successful.
783 *** 401: If the user is not authorized.
784
785 \\
786
787 * **HTTP Method:** PUT
788 ** **Accepted media types:**
789 *** application/xml (Property element)
790 *** text/plain
791 *** application/x-www-form-urlencoded (a field property#name=value pairs representing a property)
792 ** **Media types:**
793 *** application/xml (Property element)
794 ** **Description:** Modify the object properties.
795 ** **Status codes:**
796 *** 202: If the object was updated.
797 *** 401: If the user is not authorized.
798
799 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/objects[?start~=offset&number~=n] ===
800
801 * **HTTP Method:** GET
802 ** **Media types:**
803 *** application/xml (Objects element)
804 ** **Description:** The list of objects associated to a page at a given {version}.
805 ** **Status codes:**
806 *** 200: If the request was successful.
807 *** 401: If the user is not authorized.
808
809 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber} ===
810
811 * **HTTP Method:** GET
812 ** **Media types:**
813 *** application/xml (Object element)
814 ** **Description:** The object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
815 ** **Status codes:**
816 *** 200: If the request was successful.
817 *** 401: If the user is not authorized.
818
819 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties ===
820
821 * **HTTP Method:** GET
822 ** **Media types:**
823 *** application/xml (Properties element)
824 ** **Description:** The properties of the object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
825 ** **Status codes:**
826 *** 200: If the request was successful.
827 *** 401: If the user is not authorized.
828
829 === /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties/{propertyName} ===
830
831 * **HTTP Method:** GET
832 ** **Media types:**
833 *** application/xml (Properties element)
834 ** **Description:** The property {propertyname} of the object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
835 ** **Status codes:**
836 *** 200: If the request was successful.
837 *** 401: If the user is not authorized.
838
839 === /wikis/{wikiName}/class/{className}/objects ===
840
841 * **HTTP Method:** GET
842 ** **Media types:**
843 *** application/xml (Objects element)
844 ** **Description:** The list of all the objects of a given {className}.
845 ** **Status codes:**
846 *** 200: If the request was successful.
847 *** 401: If the user is not authorized.
848
849 == Class resources ==
850
851 === /wikis/{wikiName}/classes[?start~=offset&number~=n] ===
852
853 * **HTTP Method:** GET
854 ** **Media types:**
855 *** application/xml (Classes element)
856 ** **Description:** The list of all the classes defined in the wiki {wikiName}
857 ** **Status codes:**
858 *** 200: If the request was successful.
859 *** 401: If the user is not authorized.
860
861 === /wikis/{wikiName}/classes/{className} ===
862
863 * **HTTP Method:** GET
864 ** **Media types:**
865 *** application/xml (Class element)
866 ** **Description:** The {className} definition
867 ** **Status codes:**
868 *** 200: If the request was successful.
869 *** 401: If the user is not authorized.
870
871 === /wikis/{wikiName}/classes/{className}/properties ===
872
873 * **HTTP Method:** GET
874 ** **Media types:**
875 *** application/xml (Properties element)
876 ** **Description:** The properties of the class {className}.
877 ** **Status codes:**
878 *** 200: If the request was successful.
879 *** 401: If the user is not authorized.
880
881 === /wikis/{wikiName}/classes/{className}/properties/{property} ===
882
883 * **HTTP Method:** GET
884 ** **Media types:**
885 *** application/xml (Property element)
886 ** **Description:** The property {property} of the class {className}.
887 ** **Status codes:**
888 *** 200: If the request was successful.
889 *** 401: If the user is not authorized.
890
891 == Other resources ==
892
893 === /wikis/{wikiName}/modifications[?start~=offset&number~=n&date~=t] ===
894
895 * **HTTP Method:** GET
896 ** **Media types:**
897 *** application/xml (Modifications element)
898 ** **Description:** The list of the latest modification made to the wiki {wikiName} starting from time t (t is expressed in milliseconds from 1970 of the starting date)
899 ** **Status codes:**
900 *** 200: If the request was successful.
901 *** 401: If the user is not authorized.
902
903 = Custom resources =
904
905 It's possible to easily add any REST resource by registering a ##org.xwiki.rest.XWikiResource## java component on your wiki (see [[Component guide>>DevGuide.WritingComponents]] for more details).
906
907 {{code language="java"}}
908 package org.xwiki.contrib.rest;
909
910 import javax.ws.rs.DefaultValue;
911 import javax.ws.rs.GET;
912 import javax.ws.rs.Path;
913
914 import org.xwiki.component.annotation.Component;
915 import org.xwiki.rest.XWikiResource;
916
917 @Component("org.xwiki.contrib.rest.HelloWordResource")
918 @Path("/myresources/{myresourcename}")
919 class HelloWorldResource extends XWikiResource {
920 @GET
921 public String get(@PathParam("myresourcename") @DefaultValue("world") String myresourcename)
922 {
923 return "Hello " + myresourcename;
924 }
925 }
926 {{/code}}
927
928 The name of the component has to be the class FQN.
929
930 You can find more examples on [[this page>>https://github.com/xwiki/xwiki-platform/tree/master/xwiki-platform-core/xwiki-platform-rest/xwiki-platform-rest-server/src/main/java/org/xwiki/rest]].
931
932 Starting from release 4.3M2, the RESTful API modules have been refactored so that now resource declarations are available in a separate module.
933 This means that all the information about resources, i.e., URI Paths, supported methods, query parameters, and so on, are available to module developers without having to include the big REST Server module.
934
935 Clients willing to access/use the REST API can then declare a dependency on xwiki-platform-rest-api and have all this information available for interacting with it. There are two use cases for this:
936
937 * Another platform module that wants to generate responses with links to existing resources.
938 * HTTP clients that wants to make requests to the RESTful API.
939
940 The xwiki-platform-rest-api module can be also seen as an authoritative reference for the REST API.
941
942 = Generate a REST URL for a resource =
943
944 If you need to generate a REST URL for a resource inside a script, you can use the REST script services:
945
946 {{code language="velocity"}}
947 $services.rest.url($entityReference)
948 {{/code}}
949
950 Where ##$entityReference## could be:
951
952 * a ##DocumentReference##
953 * a ##SpaceReference##
954
955 We plan to add more supported entities in the future (ObjectReference, ClassReference, etc...).
956
957 = Using the RESTful API =
958
959 == Highlevel description and tutorial for a basic usage of the RESTful API ==
960
961 See [[this tutorial>>http://blog.fabio.mancinelli.me/2011/03/07/XWikis_RESTful_API.html]] by Fabio Mancinelli.
962
963 == Creating an XWiki Object ==
964
965 In this example we will use the [[curl>>http://curl.haxx.se/]] utility as the HTTP client.
966
967 Imagine that you want to create on the page Test.Test a new object of the class XWiki.TestClass, supposing that the class has a property called ##text##.
968
969 So, on the command line, you have to do the following:
970
971 {{code}}
972 $ curl -u Admin:admin
973 -X POST
974 -H "Content-type: application/xml"
975 -H "Accept: application/xml"
976 -d "@test.xml"
977 http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects
978 {{/code}}
979
980 where ##test.xml## is:
981
982 {{code language="xml"}}
983 <object xmlns="http://www.xwiki.org">
984 <className>XWiki.TestClass</className>
985 <property name="text">
986 <value>Whatever you want to put here</value>
987 </property>
988 </object>
989 {{/code}}
990
991 Alternatively you can use the less verbose ##application/x-www-form-urlencoded format##:
992
993 {{code}}
994 $ curl -u Admin:admin
995 -X POST
996 -H "Content-type: application/x-www-form-urlencoded"
997 -H "Accept: application/xml"
998 -d "@test.txt"
999 http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects
1000 {{/code}}
1001
1002 where ##test.txt## contains something like:
1003
1004 {{code}}
1005 className=XWiki.TestClass&property#test=Whatever+you+want
1006 {{/code}}
1007
1008 Or, better, you can use directly curl to specify these parameters
1009 using multiple ##-d## switches:
1010
1011 {{code}}
1012 $ curl -u Admin:admin
1013 -X POST -H "Content-type: application/x-www-form-urlencoded"
1014 -H "Accept: application/xml"
1015 -d "className=XWiki.TestClass"
1016 -d "property#test=Whatever you want"
1017 http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects
1018 {{/code}}
1019
1020 The advantage of the second approach is that curl will take care of url-encode your content, while if you send a file you are responsible for this.
1021
1022 === Remarks: ===
1023
1024 * In the ##application/x-www-form-urlencoded## format the "property#" is a standard immutable prefix that is used to distinguish attributes referring to property values from the attributes referring to the object. For example if we had ##className=XYZ&Text=FOO## we would have had an ambiguity on ##className## because we couldn't understand if ##className## is a property of the object to be set to XYZ or an attribute that describes the object itself (i.e., its metadata like the ##className##). By having the ##property### prefix this ambiguity is resolved.
1025
1026 * The information you get back when you retrieve an object (i.e., all
1027 the ##<attribute>## elements) are useful when clients need to understand the type of data contained in an object (e.g., when they want to display it). They are not necessary when creating an object because the system already has this information. That's why the XML to be sent is smaller. Actually the only information needed is the ##<className>## and a set of ##<property name="..."><value>## elements.
1028
1029 * How do you know what kind of information you can send with the XML? You can discover it by using the class description URI. If you go to ##http:~/~/localhost:8080/xwiki/rest/wikis/xwiki/classes ## you will get a list of all the classes defined in the Wiki. By looking at this you will understand what are the properties defined by each class, their types and attributes. In that way you will know what you're allowed to put in the ##<property><value>## elements of the XML you send.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected