Skip to Content

Wiki source code of REST API

Version 90.1 by Thomas Mortagne on 2022/08/08
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>>platform:Features.XWikiRESTfulAPI#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/propertyValues}}}|The representation for the list of property values.
66 |{{{http://www.xwiki.org/rel/properties}}}|The representation of the list of properties associated to the current resource.
67 |{{{http://www.xwiki.org/rel/modifications}}}|The representation of the list of modifications associated to the current resource.
68 |{{{http://www.xwiki.org/rel/children}}}|The representation of the list of children associated to the current resource.
69 |{{{http://www.xwiki.org/rel/tags}}}|The representation of the list of tags associated to the current resource.
70 |{{{http://www.xwiki.org/rel/tag}}}|The representation of a tag.
71 |{{{http://www.xwiki.org/rel/search}}}|The representation for a search resource.
72 |{{{http://www.xwiki.org/rel/syntaxes}}}|The representation for a syntax resource.
73
74 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).
75
76 == The "HATEOAS" Graph ==
77
78 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.
79
80 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.
81
82 = Interacting with the XWiki RESTful API =
83
84 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!
85 If you want to write more complex programs you might download an HTTP library for your favorite language (e.g., [[http://hc.apache.org/]]), see [[this post>>xwiki:Blog.Use the Apache HTTP library to interact with the XWiki RESTful API]] by [[Mohamed Boussaa>>xwiki:XWiki.mouhb]].
86
87 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.
88
89 If you use this approach (Apache HTTP Client + JAXB) you will find yourself writing some code like this:
90
91 {{code language="java"}}
92 import javax.xml.bind.JAXBContext;
93 import javax.xml.bind.Unmarshaller;
94
95 import org.apache.commons.httpclient.HttpClient;
96 import org.apache.commons.httpclient.methods.GetMethod;
97 import org.xwiki.rest.model.jaxb.Page;
98
99 ...
100 HttpClient httpClient = new HttpClient();
101 JAXBContext context = JAXBContext.newInstance("org.xwiki.rest.model.jaxb");
102 Unmarshaller unmarshaller = context.createUnmarshaller();
103
104 GetMethod getMethod = new GetMethod("http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome");
105 getMethod.addRequestHeader("Accept", "application/xml");
106 httpClient.executeMethod(getMethod);
107
108 Page page = (Page) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
109 {{/code}}
110
111 And you will have all the information about the Main.WebHome page in the Page object, without the need of handling XML directly.
112
113 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.
114
115 By using curl, the previous example would have been:
116
117 {{code language="xml"}}
118 $ curl http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome
119 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
120 <page xmlns="http://www.xwiki.org">
121 <link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
122 ...
123 {{/code}}
124
125 == Authentication ==
126
127 The XWiki RESTful API supports two types of authentication:
128
129 * **HTTP BASIC Auth**: You provide your credentials using the Authorization HTTP header
130 * **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.
131
132 If you don't provide any credentials the XWiki RESTful API will recognize you as a XWiki.Guest user.
133
134 So if you have, let's say a Main.PrivatePage, and you try to do:
135
136 {{code language="none"}}
137 $ curl -v http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/PrivatePage
138 ...
139 < HTTP/1.1 401 Unauthorized
140 ...
141 {{/code}}
142
143 You will get an Unauthorized empty response.
144
145 On the contrary, by specifying Admin credentials you gain access to the actual page:
146
147 {{code language="xml"}}
148 $ curl -u Admin:admin http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/PrivatePage
149 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
150 <page xmlns="http://www.xwiki.org">
151 <link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
152 ...
153 <content>Only admin can see this</content>
154 </page>
155 {{/code}}
156
157 == Sending representations ==
158
159 Many resources are modifiable, so you can send representations in order to change the state of those resources (e.g., pages).
160 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).
161
162 Resource update is usually done by using the PUT method, while resource creation is done via PUT or POST.
163
164 For example, in order to create a page you might do the following:
165
166 {{code language="xml"}}
167 $ 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
168 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
169 <page xmlns="http://www.xwiki.org">
170 <link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
171 ...
172 <version>1.1</version>
173 <majorVersion>1</majorVersion>
174 <minorVersion>1</minorVersion>
175 <created>2009-03-21+01:00</created>
176 <creator>XWiki.Admin</creator>
177 <modified>2009-03-21+01:00</modified>
178 <modifier>XWiki.Admin</modifier>
179 <content>This is a new page</content>
180 </page>
181 {{/code}}
182
183 Where newpage.xml is an XML file containing
184
185 {{code language="xml"}}
186 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
187 <page xmlns="http://www.xwiki.org">
188 <title>Hello world</title>
189 <syntax>xwiki/2.0</syntax>
190 <content>This is a new page</content>
191 </page>
192 {{/code}}
193
194 The page has been created and is accessible. Subsequent PUT requests to the page URI will modify its content.
195
196 You can specify a subset of the three elements {{{title}}}, {{{syntax}}}, and {{{content}}} in the XML when updating/creating a page.
197 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.
198
199 == Overcoming browser limitations ==
200
201 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.
202
203 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.
204
205 This overriding mechanism allows the interaction with the XWiki RESTful API by using any kind of browser.
206
207 == PUT vs POST ==
208
209 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.
210
211 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.
212
213 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.
214
215 = XWiki RESTful API Documentation =
216
217 In this section you will find the documentation of the whole XWiki RESTful API.
218
219 **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]].
220
221 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.
222
223 == Root resources ==
224
225 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)
226
227 === / ===
228
229 * **HTTP Method:** GET
230 ** **Media types:**
231 *** application/xml (XWiki element)
232 ** **Description:** Retrieves the entry root description containing information about the server (currently returns the XWiki product Version).
233 ** **Status codes:**
234 *** 200: If the request was successful.
235
236 === /syntaxes ===
237
238 * **HTTP Method:** GET
239 ** **Media types:**
240 *** application/xml (Syntaxes element)
241 ** **Description:** The list of syntaxes supported by the XWiki instance.
242 ** **Status codes:**
243 *** 200: If the request was successful.
244
245 === /wikis ===
246
247 * **HTTP Method:** GET
248 ** **Media types:**
249 *** application/xml (Wikis element)
250 ** **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'.
251 ** **Status codes:**
252 *** 200: If the request was successful.
253
254 === /wikis/query?q~={query}&wikis~=wikiList[&distinct~={true,false}][&order~={asc,desc}][&start~=n][&number~=n][&prettyNames~={true,false}] ===
255
256 * **HTTP Method:** GET
257 ** **Media types:**
258 *** application/xml (SearchResults element)
259 ** **Description:** Search resources (pages and attachments):
260 *** [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.
261 *** [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.
262 ** **Status codes:**
263 *** 200: If the request was successful.
264
265 === /wikis/{wikiName} ===
266
267 * **HTTP Method:** GET
268 ** **Media types:**
269 *** application/xml (Wiki element)
270 ** **Description:** information about the wiki
271 ** **Status codes:**
272 *** 200: If the request was successful.
273
274 * **HTTP Method:** POST
275 ** **Accepted Media types:**
276 *** octet/stream (A XAR file)
277 ** **Media types:**
278 *** application/xml (Wiki element)
279 ** **Query parameters**
280 *** backup={true/false} - import XAR as a backup XAR
281 *** history={RESET/REPLACE/ADD} - history importing
282 ** **Description:** import a XAR in a wiki.
283 ** **Status codes:**
284 *** 200: If the request was successful.
285
286 === /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}] ===
287
288 * **HTTP Method:** GET
289 ** **Media types:**
290 *** application/xml (SearchResults element)
291 ** **Description:** Returns 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} and are obtained via a HQL query.
292 ** **Status codes:**
293 *** 200: If the request was successful.
294
295 === /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] ===
296
297 * **HTTP Method:** GET
298 ** **Media types:**
299 *** application/xml (SearchResults element)
300 ** **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 type is //hql// or //xwql// and //className// is specified, the result will also contain the data for the first object of the corresponding class.
301 ** **Status codes:**
302 *** 200: If the request was successful.
303
304 === /wikimanager (This resource is only available when using the [[multi-wiki>>extensions:Extension.Wiki Application]] feature) ===
305
306 * **HTTP Method:** POST
307 ** **Accepted Media types:**
308 *** application/xml (Wiki element)
309 ** **Media types:**
310 *** application/xml (Wiki element)
311 ** **Query parameters**
312 *** template - the wiki template to be used for initializing the wiki.
313 *** history={RESET/REPLACE/ADD} - history importing
314 ** **Description:** create a new wiki.
315 ** **Status codes:**
316 *** 200: If the request was successful.
317
318 == Space resources ==
319
320 === /wikis/{wikiName}/spaces[?start~=offset&number~=n] ===
321
322 * **HTTP Method:** GET
323 ** **Media types:**
324 *** application/xml (Spaces element)
325 ** **Description:** Retrieves the list of spaces available in the {wikiName} wiki.
326 ** **Status codes:**
327 *** 200: If the request was successful.
328
329 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===
330
331 * **HTTP Method:** GET
332 ** **Media types:**
333 *** application/xml (Search results element)
334 ** **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}
335 ** **Status codes:**
336 *** 200: If the request was successful.
337 *** 401: If the user is not authorized.
338
339 == Page resources ==
340
341 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages[?start~=offset&number~=n] ===
342
343 * **HTTP Method:** GET
344 ** **Media types:**
345 *** application/xml (Pages element)
346 ** **Description:** The list of pages in the space {spaceName}
347 ** **Status codes:**
348 *** 200: If the request was successful.
349 *** 401: If the user is not authorized.
350
351 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}[?prettyNames~={true,false}&objects~={true,false}&class~={true,false}&attachments~={true,false}&minorRevision~={true,false}] ===
352
353 * **HTTP Method:** GET
354 ** **Media types:**
355 *** application/xml (Page element)
356 ** **Query parameters**
357 *** ##prettyNames##: also return the pretty name for various document information (like the author display name, etc). Disabled by default.
358 *** ##objects##: //[since 7.3M1]// also return the objects. Disabled by default.
359 *** ##class##: //[since 7.3M1]// also return the class. Disabled by default.
360 *** ##attachments##: //[since 7.3M1]// also return the attachments metadatas. Disabled by default.
361 ** **Description:**
362 ** **Status codes:**
363 *** 200: If the request was successful.
364 *** 401: If the user is not authorized.
365
366
367 * **HTTP Method:** PUT
368 ** **Accepted Media types:**
369 *** application/xml (Page element)
370 *** text/plain (Only page content)
371 *** application/x-www-form-urlencoded (allowed field names: title, parent, hidden //[since 7.3]//, content)
372 ** **Media types:**
373 *** application/xml (Page element)
374 ** **Query parameters**
375 *** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.
376 ** **Description:** Create or updates a page.
377 ** **Status codes:**
378 *** 201: If the page was created.
379 *** 202: If the page was updated.
380 *** 304: If the page was not modified.
381 *** 401: If the user is not authorized.
382
383
384 * **HTTP Method:** DELETE
385 ** **Media types:**
386 *** application/xml (Page element)
387 ** **Description:** Delete the page.
388 ** **Status codes:**
389 *** 204: If the request was successful.
390 *** 401: If the user is not authorized.
391
392 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history[?start~=offset&number~=n] ===
393
394 * **HTTP Method:** GET
395 ** **Media types:**
396 *** application/xml (History element)
397 ** **Description:** The list of all the versions of the given page.
398 ** **Status codes:**
399 *** 200: If the request was successful.
400 *** 401: If the user is not authorized.
401
402 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version} ===
403
404 * **HTTP Method:** GET
405 ** **Media types:**
406 *** application/xml (Page element)
407 ** **Description:** The page at version {version}
408 ** **Status codes:**
409 *** 200: If the request was successful.
410 *** 401: If the user is not authorized.
411
412 ==== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations[?start~=offset&number~=n] ====
413
414 * **HTTP Method:** GET
415 ** **Media types:**
416 *** application/xml (Translations element)
417 ** **Description:** The list of available translation for the page
418 ** **Status codes:**
419 *** 200: If the request was successful.
420 *** 401: If the user is not authorized.
421
422 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations/{language}[?minorRevision~={true,false}] ===
423
424 * **HTTP Method:** GET
425 ** **Media types:**
426 *** application/xml (Page element)
427 ** **Description:** The page at in the given {language}.
428 ** **Status codes:**
429 *** 200: If the request was successful.
430 *** 401: If the user is not authorized.
431
432
433 * **HTTP Method:** PUT
434 ** **Accepted Media types:**
435 *** application/xml (Page element)
436 *** text/plain (Only page content)
437 *** application/x-www-form-urlencoded (allowed field names: title, parent, content)
438 ** **Media types:**
439 *** application/xml (Page element)
440 ** **Query parameters**
441 *** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.
442 ** **Description:** Create or updates a page translation.
443 ** **Status codes:**
444 *** 201: If the page was created.
445 *** 202: If the page was updated.
446 *** 304: If the page was not modified.
447 *** 401: If the user is not authorized.
448
449
450 * **HTTP Method:** DELETE
451 ** **Media types:**
452 *** application/xml (Page element)
453 ** **Description:** Delete the page translation.
454 ** **Status codes:**
455 *** 204: If the request was successful.
456 *** 401: If the user is not authorized.
457
458 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations/{language}/history ===
459
460 * **HTTP Method:** GET
461 ** **Media types:**
462 *** application/xml (History element)
463 ** **Description:** The list of all the available revisions of the page in a given {language}.
464 ** **Status codes:**
465 *** 200: If the request was successful.
466 *** 401: If the user is not authorized.
467
468 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations/{lang}/history/{version} ===
469
470 * **HTTP Method:** GET
471 ** **Media types:**
472 *** application/xml (Page element)
473 ** **Description:** A page at a given {version} in a given {language}.
474 ** **Status codes:**
475 *** 200: If the request was successful.
476 *** 401: If the user is not authorized.
477
478 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/children ===
479
480 * **HTTP Method:** GET
481 ** **Media types:**
482 *** application/xml (Pages element)
483 ** **Description:** The list of the children of a given page.
484 ** **Status codes:**
485 *** 200: If the request was successful.
486 *** 401: If the user is not authorized.
487
488 === /wikis/{wikiName}/pages[?name~=paneName&space~=spaceName&author~=authorName] ===
489
490 * **HTTP Method:** GET
491 ** **Media types:**
492 *** application/xml (Pages element)
493 ** **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.
494 ** **Status codes:**
495 *** 200: If the request was successful.
496 *** 401: If the user is not authorized.
497
498 == Tag resources ==
499
500 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/tags[?minorRevision~={true,false}] ===
501
502 * **HTTP Method:** GET
503 ** **Media types:**
504 *** application/xml (Tags element)
505 ** **Description:** List page tags.
506 ** **Status codes:**
507 *** 200: If the request was successful.
508 *** 401: If the user is not authorized.
509
510
511 * **HTTP Method:** PUT
512 ** **Accepted Media types:**
513 *** application/xml (Tag element)
514 *** text/plain
515 *** application/x-www-form-urlencoded (allowed field names: tag)
516 ** **Media types:**
517 *** application/xml (Tags element)
518 ** **Query parameters**
519 *** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.
520 ** **Description:** Add a tag to the page.
521 ** **Status codes:**
522 *** 202: If the request was successful.
523 *** 401: If the user is not authorized.
524
525 === /wikis/{wikiName}/tags ===
526
527 * **HTTP Method:** GET
528 ** **Media types:**
529 *** application/xml (Tags element)
530 ** **Description:** The list of all available tags
531 ** **Status codes:**
532 *** 200: If the request was successful.
533 *** 401: If the user is not authorized.
534
535 === /wikis/{wikiName}/tags/{tag1}[,{tag2},{tag3}...][?start~=offset&number~=n] ===
536
537 * **HTTP Method:** GET
538 ** **Media types:**
539 *** application/xml (Pages element)
540 ** **Description:** The list of pages having the specified tags.
541 ** **Status codes:**
542 *** 200: If the request was successful.
543 *** 401: If the user is not authorized.
544
545 == Comments resources ==
546
547 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/comments[?start~=offset&number~=n] ===
548
549 * **HTTP Method:** GET
550 ** **Media types:**
551 *** application/xml (Comments element)
552 ** **Description:** The list of comments on a given page.
553 ** **Status codes:**
554 *** 200: If the request was successful.
555 *** 401: If the user is not authorized.
556
557
558 * **HTTP Method:** POST
559 ** **Accepted Media types:**
560 *** application/xml (Comment element)
561 *** text/plain
562 *** application/x-www-form-urlencoded - allowed field names: ##text##, ##replyTo## (object number of the replied comment, since XE 2.3)
563 ** **Media types:**
564 *** application/xml (Comment element)
565 ** **Description:** Create a comment on the given page.
566 ** **Status codes:**
567 *** 201: If the comment was created. (The Location header will contain the URI where the comment has been created.)
568 *** 401: If the user is not authorized.
569
570 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/comments/{commentId} ===
571
572 * **HTTP Method:** GET
573 ** **Media types:**
574 *** application/xml (Comment element)
575 ** **Description:** A specific comment on a page
576 ** **Status codes:**
577 *** 200: If the request was successful.
578 *** 401: If the user is not authorized.
579
580 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/comments ===
581
582 * **HTTP Method:** GET
583 ** **Media types:**
584 *** application/xml (Comments element)
585 ** **Description:** The list of comments at a specific page {version}.
586 ** **Status codes:**
587 *** 200: If the request was successful.
588 *** 401: If the user is not authorized.
589
590 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/comments/{commentId} ===
591
592 * **HTTP Method:** GET
593 ** **Media types:**
594 *** application/xml (Comment element)
595 ** **Description:** A comment at a specific page {version}.
596 ** **Status codes:**
597 *** 200: If the request was successful.
598 *** 401: If the user is not authorized.
599
600 == Attachments resources ==
601
602 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments[?start~=offset&number~=n] ===
603
604 * **HTTP Method:** GET
605 ** **Media types:**
606 *** application/xml (Attachments element)
607 ** **Description:** The list of attachments of a given page.
608 ** **Status codes:**
609 *** 200: If the request was successful.
610 *** 401: If the user is not authorized.
611
612 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName} ===
613
614 * **HTTP Method:** GET
615 ** **Media types:**
616 *** The same of the attachment media type.
617 ** **Description:** The attachment identified by {attachmentName} on a given page.
618 ** **Status codes:**
619 *** 200: If the request was successful.
620 *** 401: If the user is not authorized.
621
622
623 * **HTTP Method:** PUT
624 ** **Accepted media types:**
625 *** **/**
626 ** **Media types:**
627 *** application/xml (AttachmentSummary element)
628 ** **Description:** Create an attachment identified by {attachmentName} on a given page.
629 ** **Status codes:**
630 *** 201: If the attachment was created.
631 *** 202: If the attachment was updated.
632 *** 401: If the user is not authorized.
633
634
635 * **HTTP Method:** DELETE
636 ** **Media types:**
637 ** **Description:** Delete the attachment identified by {attachmentName} on a given page.
638 ** **Status codes:**
639 *** 204: If the attachment was deleted.
640 *** 401: If the user is not authorized.
641
642 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/attachments[?start~=offset&number~=n] ===
643
644 * **HTTP Method:** GET
645 ** **Media types:**
646 *** application/xml (Attachments element)
647 ** **Description:** The list of attachments at a given page {version}.
648 ** **Status codes:**
649 *** 200: If the request was successful.
650 *** 401: If the user is not authorized.
651
652 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/attachments/{attachmentName} ===
653
654 * **HTTP Method:** GET
655 ** **Media types:**
656 *** The same of the attachment media type.
657 ** **Description:** The attachment identified by {attachmentName} on a given page {version}.
658 ** **Status codes:**
659 *** 200: If the request was successful.
660 *** 401: If the user is not authorized.
661
662 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName}/history ===
663
664 * **HTTP Method:** GET
665 ** **Media types:**
666 *** application/xml (Attachments element)
667 ** **Description:** The list of available version for the {attachmentName}
668 ** **Status codes:**
669 *** 200: If the request was successful.
670 *** 401: If the user is not authorized.
671
672 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName}/history/{version} ===
673
674 * **HTTP Method:** GET
675 ** **Media types:**
676 *** The same of the attachment media type.
677 ** **Description:** The {attachmentName} at a given {version}
678 ** **Status codes:**
679 *** 200: If the request was successful.
680 *** 401: If the user is not authorized.
681
682 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/attachments[?name~=attachmentName&page~=pageName&author~=authorName&types~=attachmentTypeList&start~=offset&number~=n] ===
683
684 * **HTTP Method:** GET
685 ** **Media types:**
686 *** application/xml (Attachments element)
687 ** **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.
688 ** **Status codes:**
689 *** 200: If the request was successful.
690 *** 401: If the user is not authorized.
691
692 === /wikis/{wikiName}/attachments[?name~=attachmentName&page~=pageName&space~=spaceName&author~=authorName&types~=attachmentTypeList&start~=offset&number~=n] ===
693
694 * **HTTP Method:** GET
695 ** **Media types:**
696 *** application/xml (Attachments element)
697 ** **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.
698 ** **Status codes:**
699 *** 200: If the request was successful.
700 *** 401: If the user is not authorized.
701
702 == Object resources ==
703
704 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects[?start~=offset&number~=n] ===
705
706 * **HTTP Method:** GET
707 ** **Media types:**
708 *** application/xml (Objects element)
709 ** **Description:** The list of objects associated to a page.
710 ** **Status codes:**
711 *** 200: If the request was successful.
712 *** 401: If the user is not authorized.
713
714
715 * **HTTP Method:** POST
716 ** **Accepted media types:**
717 *** application/xml (Object element)
718 *** application/x-www-form-urlencoded (a set of property#name=value pairs representing properties and a field className)
719 **** e.g. {{code language="none"}}className=XWiki.XWikiUsers&property#first_name=John&property#last_name=Doe{{/code}}
720 ** **Media types:**
721 *** application/xml (Object element)
722 ** **Description:** Create a new object.
723 ** **Status codes:**
724 *** 201: If the object was created (The Location header will contain the URI associated to the newly created object).
725 *** 401: If the user is not authorized.
726
727 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}[?start~=offset&number~=n] ===
728
729 * **HTTP Method:** GET
730 ** **Media types:**
731 *** application/xml (Objects element)
732 ** **Description:** The list of objects of a given {className} associated to a page.
733 ** **Status codes:**
734 *** 200: If the request was successful.
735 *** 401: If the user is not authorized.
736
737 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber}[?minorRevision~={true,false}] ===
738
739 * **HTTP Method:** GET
740 ** **Media types:**
741 *** application/xml (Object element)
742 ** **Description:** The object of type {className} identified by {objectNumber} associated to the given page.
743 ** **Status codes:**
744 *** 200: If the request was successful.
745 *** 401: If the user is not authorized.
746
747
748 * **HTTP Method:** PUT
749 ** **Accepted media types:**
750 *** application/xml (Object element)
751 *** application/x-www-form-urlencoded (a set of property#name=value pairs representing properties)
752 ** **Media types:**
753 *** application/xml (Object element)
754 ** **Query parameters**
755 *** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.
756 ** **Description:** Modify the object properties.
757 ** **Status codes:**
758 *** 202: If the object was updated.
759 *** 401: If the user is not authorized.
760
761
762 * **HTTP Method:** DELETE
763 ** **Media types:**
764 ** **Description:** Delete the object.
765 ** **Status codes:**
766 *** 204: If the object was deleted.
767 *** 401: If the user is not authorized.
768
769 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber}/properties ===
770
771 * **HTTP Method:** GET
772 ** **Media types:**
773 *** application/xml (Properties element)
774 ** **Description:** The properties of the object of type {className} identified by {objectNumber} associated to the given page.
775 ** **Status codes:**
776 *** 200: If the request was successful.
777 *** 401: If the user is not authorized.
778
779 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber}/properties/{propertyName}[?minorRevision~={true,false}] ===
780
781 * **HTTP Method:** GET
782 ** **Media types:**
783 *** application/xml (Properties element)
784 ** **Description:** The property {propertyname} of the object of type {className} identified by {objectNumber} associated to the given page.
785 ** **Status codes:**
786 *** 200: If the request was successful.
787 *** 401: If the user is not authorized.
788
789
790 * **HTTP Method:** PUT
791 ** **Accepted media types:**
792 *** application/xml (Property element)
793 *** text/plain
794 *** application/x-www-form-urlencoded (a field property#name=value pairs representing a property)
795 ** **Media types:**
796 *** application/xml (Property element)
797 ** **Query parameters**
798 *** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.
799 ** **Description:** Modify the object properties.
800 ** **Status codes:**
801 *** 202: If the object was updated.
802 *** 401: If the user is not authorized.
803
804 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects[?start~=offset&number~=n] ===
805
806 * **HTTP Method:** GET
807 ** **Media types:**
808 *** application/xml (Objects element)
809 ** **Description:** The list of objects associated to a page at a given {version}.
810 ** **Status codes:**
811 *** 200: If the request was successful.
812 *** 401: If the user is not authorized.
813
814 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber} ===
815
816 * **HTTP Method:** GET
817 ** **Media types:**
818 *** application/xml (Object element)
819 ** **Description:** The object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
820 ** **Status codes:**
821 *** 200: If the request was successful.
822 *** 401: If the user is not authorized.
823
824 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties ===
825
826 * **HTTP Method:** GET
827 ** **Media types:**
828 *** application/xml (Properties element)
829 ** **Description:** The properties of the object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
830 ** **Status codes:**
831 *** 200: If the request was successful.
832 *** 401: If the user is not authorized.
833
834 === /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties/{propertyName} ===
835
836 * **HTTP Method:** GET
837 ** **Media types:**
838 *** application/xml (Properties element)
839 ** **Description:** The property {propertyName} of the object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
840 ** **Status codes:**
841 *** 200: If the request was successful.
842 *** 401: If the user is not authorized.
843
844 === /wikis/{wikiName}/classes/{className}/objects[?start~=offset&number~=n] ===
845
846 * **HTTP Method:** GET
847 ** **Media types:**
848 *** application/xml (Objects element)
849 ** **Description:** The list of all the objects of a given {className}.
850 ** **Status codes:**
851 *** 200: If the request was successful.
852 *** 401: If the user is not authorized.
853
854 == Class resources ==
855
856 === /wikis/{wikiName}/classes[?start~=offset&number~=n] ===
857
858 * **HTTP Method:** GET
859 ** **Media types:**
860 *** application/xml (Classes element)
861 ** **Description:** The list of all the classes defined in the wiki {wikiName}
862 ** **Status codes:**
863 *** 200: If the request was successful.
864 *** 401: If the user is not authorized.
865
866 === /wikis/{wikiName}/classes/{className} ===
867
868 * **HTTP Method:** GET
869 ** **Media types:**
870 *** application/xml (Class element)
871 ** **Description:** The {className} definition
872 ** **Status codes:**
873 *** 200: If the request was successful.
874 *** 401: If the user is not authorized.
875
876 === /wikis/{wikiName}/classes/{className}/properties ===
877
878 * **HTTP Method:** GET
879 ** **Media types:**
880 *** application/xml (Properties element)
881 ** **Description:** The properties of the class {className}.
882 ** **Status codes:**
883 *** 200: If the request was successful.
884 *** 401: If the user is not authorized.
885
886 === /wikis/{wikiName}/classes/{className}/properties/{propertyName} ===
887
888 * **HTTP Method:** GET
889 ** **Media types:**
890 *** application/xml (Property element)
891 ** **Description:** The property {propertyName} of the class {className}.
892 ** **Status codes:**
893 *** 200: If the request was successful.
894 *** 401: If the user is not authorized.
895
896 === /wikis/{wikiName}/classes/{className}/properties/{propertyName}/values {{info}}Since 9.8RC1{{/info}} ===
897
898 Request parameters:
899
900 |=Name|=Description|
901 |limit|Limit the number of values returned. Zero or a negative number means no limit.
902 |fp|Filter parameters, used to filter the returned values. You can pass multiple filter values by repeating the query string parameter. The way in which the property values are filtered depends on the property type.
903
904 * **HTTP Method:** GET
905 ** **Media types:**
906 *** application/xml (Property element)
907 ** **Description:** The list of values for the property {propertyName} of the class {className}. At the moment only Database List properties are supported.
908 ** **Status codes:**
909 *** 200: If the request was successful.
910 *** 401: If the user is not authorized to view the specified property.
911 *** 404: If the specified property doesn't exist.
912
913 == Job resources ==
914
915 A job is identified by an ID (##jobId##) which is a list of strings. In the REST URL, you have to represent the ID with a list of strings separated by ##/##. (eg: ##refactoring/delete/11451##).
916
917 === /jobstatus/{jobId} {{info}}Since 7.2M3{{/info}} ===
918
919 Request parameters:
920
921 |=Name|=Required|=Values|=Default|=Description|=Version
922 |##request##|no|##true~|false##|##false##|Return also the job request|9.1RC1
923 |##progress##|no|##true~|false##|##true##|Return also the job progress|9.1RC1
924 |##log##|no|##true~|false##|##false##|Return also the job log|9.1RC1
925 |##log_fromLevel##|no|##error~|warn~|info~|debug~|trace##| |Indicate the level from which to return logs|9.1RC1
926
927 * **HTTP Method:** GET
928 ** **Media types:**
929 *** application/xml (JobStatus element)
930 ** **Description:** status of a job
931 ** **Status codes:**
932 *** 200: If the request was successful.
933 *** 404: If the job status has not been found
934
935 === /joblog/{jobId} {{info}}Since 7.2M3{{/info}} ===
936
937 Request parameters:
938
939 |=Name|=Required|=Values|=Default|=Description|=Version
940 |##level##|no|##error~|warn~|info~|debug~|trace##| |Indicate the exact level for which to return logs|7.2M3
941 |##fromLevel##|no|##error~|warn~|info~|debug~|trace##| |Indicate the level from which to return logs|7.2M3
942
943 * **HTTP Method:** GET
944 ** **Media types:**
945 *** application/xml (JobLog element)
946 ** **Description:** log of a job
947 ** **Status codes:**
948 *** 200: If the request was successful.
949 *** 404: If the job status has not been found
950
951 === /jobs {{info}}Since 9.1RC1{{/info}} ===
952
953 Request parameters:
954
955 |=Name|=Required|=Values|=Default|=Description|=Version
956 |##jobType##|yes| | |The type of the job to pass to the Job Executor|9.1RC1
957 |##async##|no|##true~|false##|##true##|If false, return the response only when the job is done|9.1RC1
958
959 This API is designed to be a REST clone of the JobExecutor Java API (the only real difference right now being way to deal with asynchronous jobs) documented on http://extensions.xwiki.org/xwiki/bin/view/Extension/Job+Module#HUseanexistingjob so the concepts (job type, job request) are the same and the exact information to put in the job request depends on the job you want to run and are usually documented in the extension this job is coming from (extension module, refactoring, etc.).
960
961 * **HTTP Method:** PUT
962 ** **Input:**
963 *** Media Types: ##application/xml## or ##application/json##
964 *** Input body: ##JobRequest## element
965 ** **Output:**
966 *** Media Types: ##application/xml## or ##application/json##
967 *** Response body: ##JobStatus## element
968 ** **Description:** Start a new job synchronously or asynchronously
969 ** **Status codes:**
970 *** 200: If the job was successfully executed
971 *** 401: If the user is not authorized (i.e. doesn't have Programming Rights)
972 *** 500: Failing jobs with ##async=false## return an error 500 (Since 9.7RC1)
973
974 Jobs started through the REST API automatically get their runtime context injected with the following REST HTTP request context properties:
975
976 * current wiki
977 * current user
978 * request URL and parameters
979
980 There is JAXB objects provided to make easy to create a request for Java and other JVM based clients. For other use cases the hard part is generally generating the XML to send as content and you can either:
981 * ask for the status of an existing job to have an hint of how the XML/JSON should look like (see [[jobstatus section>>#H2Fjobstatus2F7BjobId7D]])
982 * generate this XML in a script in a wiki page, you can look at the following example to help with that: https://snippets.xwiki.org/xwiki/bin/view/Extension/Generate%20Refactoring%20Job%20REST%20request%20XML/
983
984 === Example of Extension Manager installJob ===
985
986 Using the attach:installjobrequest.xml file you can use a request like the following one to ask for the installation of an extension (in this example the XWiki OIDC module version 1.28):
987
988 {{code language="none"}}
989 curl -i --user "Admin:admin" -X PUT -H "Content-Type: text/xml" "http://localhost:8080/xwiki/rest/jobs?jobType=install&async=false" --upload-file installjobrequest.xml
990 {{/code}}
991
992 == Localization resources ==
993
994 For more details see the [[Localization Module documentation>>extensions:Extension.Localization.WebHome]].
995
996 {{version since="13.3RC1"}}
997 === /wikis/{wikiName}/localization/translations[?locale~=l&prefix~=p[&key~=k]*] ===
998
999 * **HTTP Method**: GET
1000 ** **Media Types:** ##application/xml## or ##application/json##
1001 ** **Description: **The list of translations of the requested keys in a given locale
1002 ** **Query Parameters:**
1003 *** **locale:** (optional) the locale of the returned translation, if missing the locale is resolved from the context
1004 *** **prefix:** (optional) a common prefix concatenated to all the provided keys.
1005 *** **key:** (multiple) a list of translation keys
1006 ** **Status Code:**
1007 *** 200: if the request was successful
1008 ** **Response:**
1009 *** a list of translation objects, each containing the translation key (concatenated with the prefix) and the resolved raw sources (the translation values without the parameters resolved).
1010 {{/version}}
1011
1012 == Icon Theme resources ==
1013
1014 For more details see the [[extensions:Extension.Icon Theme Application.WebHome]].
1015
1016 {{version since="13.3RC1"}}
1017 === /wikis/{wikiName}/iconThemes/icons[?[name~=n]*] ===
1018
1019 * **HTTP Method**: GET
1020 ** **Media Types:** ##application/xml## or ##application/json##
1021 ** **Description: **Provides the metadata of the icons of the current icon theme in a given ##{wikiName}## wiki
1022 ** **Query Parameters:**
1023 *** **name:** (multiple) the name of the requested icons
1024 ** **Status Code:**
1025 *** 200: if the request was successful
1026 ** **Response:**
1027 *** An object with two attributes: ##icon## is a list of the requested icons metadata, and ##missingIcons## an array of names of requested icons that couldn't be found in the current theme.
1028
1029
1030 === /wikis/{wikiName}/iconThemes/{iconTheme}/icons[?[name~=n]*] ===
1031
1032 * **HTTP Method**: GET
1033 ** **Media Types:** ##application/xml## or ##application/json##
1034 ** **Description: **Provides the metadata of the icons of the ##{iconTheme}## icon theme in a given ##{wikiName}## wiki
1035 ** **Query Parameters:**
1036 *** **name:** (multiple) the name of the requested icons
1037 ** **Status Code:**
1038 *** 200: if the request was successful
1039 ** **Response:**
1040 *** An object with two attributes: ##icon## is a list of the requested icons metadata, and ##missingIcons## an array of names of requested icons that couldn't be found in the requested theme.
1041 {{/version}}
1042
1043 == Other resources ==
1044
1045 === /wikis/{wikiName}/modifications[?start~=offset&number~=n&date~=t] ===
1046
1047 * **HTTP Method:** GET
1048 ** **Media types:**
1049 *** application/xml (Modifications element)
1050 ** **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)
1051 ** **Status codes:**
1052 *** 200: If the request was successful.
1053 *** 401: If the user is not authorized.
1054
1055 = Custom resources =
1056
1057 == In Wiki Pages ==
1058
1059 If you can't find an existing REST endpoint for your needs, you can create your own own by creating a wiki page and putting script in it. For example let's imagine you'd like to get a list of all pages under a given space. You could write a page, say ##GetChildren## with the following content:
1060
1061 {{code language="velocity"}}
1062 {{velocity}}
1063 #if ("$!request.space" != '')
1064 #set ($discard = $response.setContentType('text/xml'))
1065 <?xml version="1.0" encoding="UTF-8"?>
1066 <pages>
1067 #set ($query = $services.query.xwql("select doc.fullName from Document doc where ((doc.space like :spacelike escape '!') or (doc.space = :space)) and language='' order by doc.date desc"))
1068 #set ($spaceReferenceString = $request.space)
1069 #set ($spaceLike = $spaceReferenceString.replaceAll('([%_!])', '!$1').concat('.%'))
1070 #set ($query = $query.bindValue('spacelike', $spaceLike))
1071 #set ($query = $query.bindValue('space', $spaceReferenceString))
1072 #foreach ($item in $query.execute())
1073 <page>$item</page>
1074 #end
1075 </pages>
1076 #end
1077 {{/velocity}}
1078 {{/code}}
1079
1080 The calling it for example with the following URL ##http:~/~/localhost:8080/xwiki/bin/get/GetChildren/?space=Sandbox&xpage=plain&outputSyntax=plain## would give something like:
1081
1082 {{code language="none"}}
1083 <pages>
1084 <page>Sandbox.Test.WebHome</page>
1085 <page>Sandbox.TestPage2</page>
1086 <page>Sandbox.ApplicationsPanelEntry</page>
1087 <page>Sandbox.TestPage3</page>
1088 <page>Sandbox.TestPage1</page>
1089 <page>Sandbox.WebPreferences</page>
1090 <page>Sandbox.WebHome</page>
1091 </pages>
1092 {{/code}}
1093
1094 == In Java ==
1095
1096 It's possible to easily add any REST resource by registering a ##org.xwiki.rest.XWikiResource## java component on your wiki (see [[Component guide>>platform:DevGuide.WritingComponents]] for more details).
1097
1098 {{code language="java"}}
1099 package org.xwiki.contrib.rest;
1100
1101 import javax.ws.rs.DefaultValue;
1102 import javax.ws.rs.GET;
1103 import javax.ws.rs.Path;
1104
1105 import org.xwiki.component.annotation.Component;
1106 import org.xwiki.rest.XWikiResource;
1107
1108 @Component("org.xwiki.contrib.rest.HelloWorldResource")
1109 @Path("/myresources/{myresourcename}")
1110 public class HelloWorldResource extends XWikiResource {
1111 @GET
1112 public String get(@PathParam("myresourcename") @DefaultValue("world") String myresourcename)
1113 {
1114 return "Hello " + myresourcename;
1115 }
1116 }
1117 {{/code}}
1118
1119 The name of the component has to be the class FQN.
1120
1121 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]].
1122
1123 Starting from release 4.3M2, the RESTful API modules have been refactored so that now resource declarations are available in a separate module.
1124 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.
1125
1126 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:
1127
1128 * Another platform module that wants to generate responses with links to existing resources.
1129 * HTTP clients that wants to make requests to the RESTful API.
1130
1131 The xwiki-platform-rest-api module can be also seen as an authoritative reference for the REST API.
1132
1133 = Generate a REST URL for a resource =
1134
1135 If you need to generate a REST URL as String for a resource inside a script, you can use the REST script services:
1136
1137 {{code language="velocity"}}
1138 ## Return a relative URL String unless the reference wiki is different from the current wiki
1139 $services.rest.url($entityReference)
1140
1141 ## Force returning an external form URL String, false as second parameter would have the same effect that the previous call
1142 $services.rest.url($entityReference, true)
1143
1144 ## String parameter automaticallly converter to entity reference
1145 $services.rest.url('MySpace.MyPage')
1146 $services.rest.url('document:MySpace.MyPage')
1147 $services.rest.url('space:MySpace')
1148 {{/code}}
1149
1150 Where ##$entityReference## could be:
1151
1152 * a ##DocumentReference##
1153 * a ##SpaceReference##
1154
1155 We plan to add more supported entities in the future (ObjectReference, ClassReference, etc...).
1156
1157 = Using the RESTful API =
1158
1159 == Tutorial ==
1160
1161 See [[this tutorial>>http://blog.fabio.mancinelli.me/2011/03/07/XWikis_RESTful_API.html]] by Fabio Mancinelli.
1162
1163 == Creating an XWiki Object ==
1164
1165 In this example we will use the [[curl>>http://curl.haxx.se/]] utility as the HTTP client.
1166
1167 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##.
1168
1169 So, on the command line, you have to do the following:
1170
1171 {{code}}
1172 $ curl -u Admin:admin
1173 -X POST
1174 -H "Content-type: application/xml"
1175 -H "Accept: application/xml"
1176 -d "@test.xml"
1177 http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects
1178 {{/code}}
1179
1180 where ##test.xml## is:
1181
1182 {{code language="xml"}}
1183 <object xmlns="http://www.xwiki.org">
1184 <className>XWiki.TestClass</className>
1185 <property name="text">
1186 <value>Whatever you want to put here</value>
1187 </property>
1188 </object>
1189 {{/code}}
1190
1191 Alternatively you can use the less verbose ##application/x-www-form-urlencoded format##:
1192
1193 {{code}}
1194 $ curl -u Admin:admin
1195 -X POST
1196 -H "Content-type: application/x-www-form-urlencoded"
1197 -H "Accept: application/xml"
1198 -d "@test.txt"
1199 http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects
1200 {{/code}}
1201
1202 where ##test.txt## contains something like:
1203
1204 {{code}}
1205 className=XWiki.TestClass&property#test=Whatever+you+want
1206 {{/code}}
1207
1208 Or, better, you can use directly curl to specify these parameters
1209 using multiple ##-d## switches:
1210
1211 {{code}}
1212 $ curl -u Admin:admin
1213 -X POST -H "Content-type: application/x-www-form-urlencoded"
1214 -H "Accept: application/xml"
1215 -d "className=XWiki.TestClass"
1216 -d "property#test=Whatever you want"
1217 http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects
1218 {{/code}}
1219
1220 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.
1221
1222 === Remarks: ===
1223
1224 * 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.
1225
1226 * The information you get back when you retrieve an object (i.e., all
1227 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.
1228
1229 * 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.
1230
1231 == Formats of files ==
1232
1233 A XSD schema exists for XWiki (look [[here>>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]] for the source).
1234
1235 However, you may not know exactly how to write the XML files to use when using the PUT method. First thing to know, you may try to get examples by using ##GET## HTTP request to the REST service using cURL or similar tools.
1236
1237 But in order to help you, you'll find below the different formats that you can use. Note that the following XML files are exhaustive files but not all the elements are required.
1238
1239 === Example of a file for a ##wiki## ===
1240
1241 {{code language="xml"}}
1242 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
1243 <wiki xmlns="http://www.xwiki.org">
1244 <id>xwiki</id>
1245 <name>xwiki</name>
1246 <description>Some description of the wiki</description>
1247 <owner>Admin</owner>
1248 </wiki>
1249 {{/code}}
1250
1251 === Example of a file for a ##space## ===
1252
1253 {{code language="xml"}}
1254 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
1255 <space xmlns="http://www.xwiki.org">
1256 <id>xwiki:Main</id>
1257 <wiki>xwiki</wiki>
1258 <name>Main</name>
1259 <home>xwiki:Main.WebHome</home>
1260 <xwikiRelativeUrl>http://localhost:8080/xwiki/bin/view/Main/</xwikiRelativeUrl>
1261 <xwikiAbsoluteUrl>http://localhost:8080/xwiki/bin/view/Main/</xwikiAbsoluteUrl>
1262 </space>
1263 {{/code}}
1264
1265 === Example of a file for a ##page## ===
1266
1267 {{code language="xml"}}
1268 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
1269 <page xmlns="http://www.xwiki.org">
1270 <id>xwiki:Main.WebHome</id>
1271 <fullName>Main.WebHome</fullName>
1272 <wiki>xwiki</wiki>
1273 <space>Main</space>
1274 <name>WebHome</name>
1275 <title>Home</title>
1276 <parent></parent>
1277 <parentId></parentId>
1278 <version>1.1</version>
1279 <author>XWiki.Admin</author>
1280 <authorName>Administrator</authorName>
1281 <xwikiRelativeUrl>http://localhost:8080/xwiki/bin/view/Main/</xwikiRelativeUrl>
1282 <xwikiAbsoluteUrl>http://localhost:8080/xwiki/bin/view/Main/</xwikiAbsoluteUrl>
1283 <translations></translations>
1284 <syntax>xwiki/2.0</syntax>
1285 <language></language>
1286 <majorVersion>1</majorVersion>
1287 <minorVersion>1</minorVersion>
1288 <hidden>false</hidden>
1289 <created>2009-09-09T02:00:00+02:00</created>
1290 <creator>XWiki.Admin</creator>
1291 <creatorName>Administrator</creatorName>
1292 <modified>2015-10-29T11:19:02+01:00</modified>
1293 <modifier>XWiki.Admin</modifier>
1294 <modifierName>Administrator</modifierName>
1295 <comment>Imported from XAR</comment>
1296 <content>{{include reference="Dashboard.WebHome" context="new"/}}</content>
1297 </page>
1298 {{/code}}
1299
1300 === Example of a file for a ##tag## ===
1301
1302 {{code language="xml"}}
1303 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
1304 <tags xmlns="http://www.xwiki.org">
1305 <tag name="food"></tag>
1306 </tags>
1307 {{/code}}
1308
1309 === Example of a file for a ##comment## ===
1310
1311 {{code language="xml"}}
1312 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
1313 <comments xmlns="http://www.xwiki.org">
1314 <comment>
1315 <id>0</id>
1316 <pageId>xwiki:Main.WebHome</pageId>
1317 <author>XWiki.Admin</author>
1318 <authorName>Administrator</authorName>
1319 <date>2015-11-13T18:20:51.936+01:00</date>
1320 <highlight></highlight>
1321 <text>This is a comment</text>
1322 <replyTo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"></replyTo>
1323 </comment>
1324 </comments>
1325 {{/code}}
1326
1327 === Example of a file for an ##object## ===
1328
1329 {{code language="xml"}}
1330 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
1331 <object xmlns="http://www.xwiki.org">
1332 <id>xwiki:Main.WebHome:c170a0a8-cc17-41cd-aa1e-6f6faf1d9f28</id>
1333 <guid>c170a0a8-cc17-41cd-aa1e-6f6faf1d9f28</guid>
1334 <pageId>xwiki:Main.WebHome</pageId>
1335 <pageVersion>1.1</pageVersion>
1336 <wiki>xwiki</wiki>
1337 <space>Main</space>
1338 <pageName>WebHome</pageName>
1339 <pageAuthor>XWiki.superadmin</pageAuthor>
1340 <className>XWiki.EditModeClass</className>
1341 <number>0</number>
1342 <headline>edit</headline>
1343 <property name="defaultEditMode" type="String">
1344 <attribute name="name" value="defaultEditMode"></attribute>
1345 <attribute name="prettyName" value="Default Edit Mode"></attribute>
1346 <attribute name="unmodifiable" value="0"></attribute>
1347 <attribute name="disabled" value="0"></attribute>
1348 <attribute name="size" value="15"></attribute>
1349 <attribute name="number" value="1"></attribute>
1350 <value>edit</value>
1351 </property>
1352 </object>
1353 {{/code}}
1354
1355 === Example of a file for a ##property## ===
1356
1357 {{code language="xml"}}
1358 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
1359 <property xmlns="http://www.xwiki.org" name="defaultEditMode" type="String">
1360 <attribute name="name" value="defaultEditMode"></attribute>
1361 <attribute name="prettyName" value="Default Edit Mode"></attribute>
1362 <attribute name="unmodifiable" value="0"></attribute>
1363 <attribute name="disabled" value="0"></attribute>
1364 <attribute name="size" value="15"></attribute>
1365 <attribute name="number" value="1"></attribute>
1366 <value>edit</value>
1367 </property>
1368 {{/code}}
1369
1370 = Examples =
1371
1372 == Getting the list of users ==
1373
1374 Since Users are stored as Objects, you can do a search of the type ##XWiki.XWikiUsers##. For example:
1375
1376 {{code}}
1377 http://<server>/xwiki/rest/wikis/query?q=object:XWiki.XWikiUsers
1378 {{/code}}
1379
1380 == Getting the list of users using XWQL ==
1381
1382 Using the parameter "className" the result includes the data for the first object of the ##XWiki.XWikiUsers##:
1383
1384 {{code}}
1385 http://<server>/xwiki/rest/wikis/xwiki/query?q=,doc.object(XWiki.XWikiUsers) as obj&type=xwql&className=XWiki.XWikiUsers
1386 {{/code}}

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected