REST API (XWiki.org)

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

12

https://<host>:<port>/<context>/rest

Where:

* ##host## and ##port## are the domain and port where XWiki is installed

18

* ##context## is the Servlet Context under which XWiki is deployed in the Servlet container. By default the value is ##xwiki##, and if XWiki is installed as a "root" web application as in the [[official Docker image>>https://hub.docker.com/_/xwiki/]], the value is empty (and the REST API is then available at {{code language="none"}}https://<host>:<port>/rest{{/code}}).

19

20

All the resource references described in the [[XWiki RESTful API Documentation>>#HXWikiRESTfulAPIDocumentation]] should be intended relative to this URL.

21

22

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##

23

24

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 or by setting the ##Accept## header in the request to ##application/json##. For example:

25

26

* ##http:~/~/localhost:8080/xwiki/rest/wikis?media=json##

27

* ##curl -H 'Accept: application/json' https:~/~/www.xwiki.org/xwiki/rest/##

= Dataset =

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.

32

33

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.

34

35

= Understanding resources and representations =

36

37

"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]])

38

39

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]].

40

41

Of course the same resource can be represented in many different ways. This is yet to be documented.

42

43

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.

44

45

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.

46

47

[[image:representation||height="430"]]

== Relations ==

The available relations that you might find in the XML resource representations are the following:

52

53

|=Rel|=Semantics

54

|{{{http://www.xwiki.org/rel/wikis}}}|The representation containing the list of virtual wikis.

55

|{{{http://www.xwiki.org/rel/spaces}}}|The representation containing the list of spaces in a wiki.

56

|{{{http://www.xwiki.org/rel/pages}}}|The representation containing the list of pages in a space.

57

|{{{http://www.xwiki.org/rel/translation}}}|The representation containing a translation of a page.

58

|{{{http://www.xwiki.org/rel/page}}}|The representation for a page.

59

|{{{http://www.xwiki.org/rel/space}}}|The representation for a space.

60

|{{{http://www.xwiki.org/rel/parent}}}|The representation for the page that is parent of the current resource.

61

|{{{http://www.xwiki.org/rel/home}}}|The representation for the page that is the home of the current resource.

62

|{{{http://www.xwiki.org/rel/attachmentData}}}|The representation of the actual attachment data.

63

|{{{http://www.xwiki.org/rel/comments}}}|The representation of the list of comments associated to the current resource.

64

|{{{http://www.xwiki.org/rel/attachments}}}|The representation of the list of attachments associated to the current resource.

65

|{{{http://www.xwiki.org/rel/objects}}}|The representation of the list of objects associated to the current resource.

66

|{{{http://www.xwiki.org/rel/object}}}|The representation for an object.

67

|{{{http://www.xwiki.org/rel/classes}}}|The representation of the list of classes associated to the current resource.

68

|{{{http://www.xwiki.org/rel/history}}}|The representation of the list of history information associated to the current resource.

69

|{{{http://www.xwiki.org/rel/class}}}|The representation for a class.

70

|{{{http://www.xwiki.org/rel/property}}}|The representation for a property.

71

|{{{http://www.xwiki.org/rel/propertyValues}}}|The representation for the list of property values.

72

|{{{http://www.xwiki.org/rel/properties}}}|The representation of the list of properties associated to the current resource.

73

|{{{http://www.xwiki.org/rel/modifications}}}|The representation of the list of modifications associated to the current resource.

74

|{{{http://www.xwiki.org/rel/children}}}|The representation of the list of children associated to the current resource.

75

|{{{http://www.xwiki.org/rel/tags}}}|The representation of the list of tags associated to the current resource.

76

|{{{http://www.xwiki.org/rel/tag}}}|The representation of a tag.

77

|{{{http://www.xwiki.org/rel/search}}}|The representation for a search resource.

78

|{{{http://www.xwiki.org/rel/syntaxes}}}|The representation for a syntax resource.

79

|{{{http://www.xwiki.org/rel/user}}}|{{version since="18.2.0RC1"}}The representation for a user resource.{{/version}}

80

81

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).

82

83

== The "HATEOAS" Graph ==

84

85

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.

86

87

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.

88

89

= Interacting with the XWiki RESTful API =

90

91

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!

92

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]].

93

94

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.

95

96

If you use this approach (Apache HTTP Client + JAXB) you will find yourself writing some code like this:

97

98

99

import javax.xml.bind.JAXBContext;

100

import javax.xml.bind.Unmarshaller;

101

102

import org.apache.commons.httpclient.HttpClient;

103

import org.apache.commons.httpclient.methods.GetMethod;

104

import org.xwiki.rest.model.jaxb.Page;

105

106

...

107

HttpClient httpClient = new HttpClient();

108

JAXBContext context = JAXBContext.newInstance("org.xwiki.rest.model.jaxb");

109

Unmarshaller unmarshaller = context.createUnmarshaller();

110

111

GetMethod getMethod = new GetMethod("http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome");

112

getMethod.addRequestHeader("Accept", "application/xml");

113

httpClient.executeMethod(getMethod);

114

115

Page page = (Page) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());

116

117

118

And you will have all the information about the Main.WebHome page in the Page object, without the need of handling XML directly.

119

120

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.

121

122

By using curl, the previous example would have been:

123

124

125

$ curl http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome

...

== Authentication ==

The XWiki RESTful API supports several types of authentication:

135

136

* **HTTP BASIC Auth**: You provide your credentials using the Authorization HTTP header

137

* **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.

138

* **Custom authentication methods:** if you have setup a custom authenticator on your wiki (such as [[OIDC>>extensions:Extension.OpenID Connect.WebHome]], or [[Trusted authentication>>extensions:Extension.Trusted authentication framework]] or even your own custom ones), additional authentication methods may be available for the RESTful API, provided by these authenticators.

139

140

If you don't provide any credentials the XWiki RESTful API will recognize you as a XWiki.Guest user.

141

142

So if you have, let's say a Main.PrivatePage, and you try to do:

143

144

145

$ curl -v http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/PrivatePage

146

...

147

< HTTP/1.1 401 Unauthorized

...

You will get an Unauthorized empty response.

152

153

On the contrary, by specifying Admin credentials you gain access to the actual page:

154

155

156

$ curl -u Admin:admin http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/PrivatePage

...

<content>Only admin can see this</content>

</page>

=== CSRF Token ===

When using a ##POST## request with a content type of ##text/plain##, ##multipart/form-data## or ##application/www-form-urlencoded##, a form token needs to be sent in the header ##XWiki-Form-Token## to prevent cross-site request forgery. The form token is provided in every response in the same header so a ##GET## request to any supported endpoint can be used to obtain a form token. If the form token is missing or wrong, a response with status code 403 and "Invalid or missing form token." as body of type ##text/plain## is sent. As of XWiki 15.2, the form token will stay the same for a user until the server is restarted. As server restarts might happen at any time, API clients should handle this response code and re-try the request with the form token that is returned in the error response. When the form token is provided in a request where it isn't necessary, it won't be checked for validity so it doesn't hurt to just send the token in every request.

169

170

It cannot be excluded that in the future, the form token might depend on the user's session. Therefore, for compatibility with future versions, it might be a good idea to store and send cookies.

171

172

When using the REST API in JavaScript code from within XWiki's UI, the form token is automatically sent in every same-origin request initiated through ##fetch## or ##XMLHttpRequest##. Therefore, no special steps should be needed for REST requests to the current XWiki instance.

173

174

175

== Sending representations ==

176

177

Many resources are modifiable, so you can send representations in order to change the state of those resources (e.g., pages).

178

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).

179

180

Resource update is usually done by using the PUT method, while resource creation is done via PUT or POST.

181

182

For example, in order to create a page you might do the following:

183

184

185

$ 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

...

<creator>XWiki.Admin</creator>

195

196

<modifier>XWiki.Admin</modifier>

</page>

Where newpage.xml is an XML file containing

<title>Hello world</title>

207

<syntax>xwiki/2.0</syntax>

</page>

The page has been created and is accessible. Subsequent PUT requests to the page URI will modify its content.

213

214

You can specify a subset of the three elements {{{title}}}, {{{syntax}}}, and {{{content}}} in the XML when updating/creating a page.

215

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.

216

217

== Overcoming browser limitations ==

218

219

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.

220

221

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.

222

223

This overriding mechanism allows the interaction with the XWiki RESTful API by using any kind of browser.

== PUT vs POST ==

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.

228

229

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.

230

231

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.

== Headers ==

The response of the REST requests always contain some custom headers that might be useful:

236

237

* ##xwiki-version##: contains the representation of the version returned by of XWiki#getVersion (generally the version of the WAR package)

238

* ##xwiki-user##: contains the reference of the user used to perform the request (e.g. xwiki:XWiki.JohnDoe). If the request is performed as guest, the header won't be present.

== Limits ==

REST APIs that return data from more than a single page (like searching, listing pages and spaces, …) return at maximum 1000 items per request by default. Specifying a higher limit or -1 (for unlimited) will result in a response with error 400 Bad Request. Pagination needs to be used to retrieve more results. See the [[documentation about query limits>>extensions:Extension.Query Module#HQueryLimits]] how to configure or remove this limit.

244

245

246

= XWiki RESTful API Documentation =

247

248

In this section you will find the documentation of the whole XWiki RESTful API.

249

250

**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]].

251

252

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.

== Root resources ==

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)

=== / ===

* **HTTP Method:** GET

261

** **Media types:**

262

*** application/xml (XWiki element)

263

** **Description:** Retrieves the entry root description containing information about the server (currently returns the XWiki product Version).

264

** **Status codes:**

265

*** 200: If the request was successful.

=== /syntaxes ===

* **HTTP Method:** GET

270

** **Media types:**

271

*** application/xml (Syntaxes element)

272

** **Description:** The list of syntaxes supported by the XWiki instance.

273

** **Status codes:**

274

*** 200: If the request was successful.

=== /wikis ===

* **HTTP Method:** GET

279

** **Media types:**

280

*** application/xml (Wikis element)

281

** **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'.

282

** **Status codes:**

283

*** 200: If the request was successful.

284

285

=== /wikis/query?q~={query}&wikis~=wikiList[&distinct~={true,false}][&order~={asc,desc}][&start~=n][&number~=n][&prettyNames~={true,false}] ===

286

287

* **HTTP Method:** GET

288

** **Media types:**

289

*** application/xml (SearchResults element)

290

** **Description:** Search resources (pages and attachments):

291

*** [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.

292

*** [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.

293

** **Status codes:**

294

*** 200: If the request was successful.

295

296

=== /wikis/{wikiName} ===

297

298

* **HTTP Method:** GET

299

** **Media types:**

300

*** application/xml (Wiki element)

301

** **Description:** information about the wiki

302

** **Status codes:**

303

*** 200: If the request was successful.

304

305

* **HTTP Method:** POST

306

** **Accepted Media types:**

307

*** octet/stream (A XAR file)

308

** **Media types:**

309

*** application/xml (Wiki element)

310

** **Query parameters**

311

*** backup={true/false} - import XAR as a backup XAR

312

*** history={RESET/REPLACE/ADD} - history importing

313

** **Description:** import a XAR in a wiki.

314

** **Status codes:**

315

*** 200: If the request was successful.

316

317

=== /wikis/{wikiName}/children?[offset~=0][&limit~=-1][&search~=] ===

318

319

320

* **HTTP Method:** GET

321

** **Media types:**

322

*** application/xml (Pages element)

323

** **Query parameters**

324

*** offset={integer} the index of the first child page to return, defaults to 0

325

*** limit={integer} the maximum number of child pages to return, defaults to -1 which means no limit

326

*** search={string} a search string to filter the child pages by name or title, defaults to empty string which means no filtering

327

** **Description:** the top level pages in the specified wiki

328

** **Status codes:**

329

*** 200: If the request was successful.

330

331

332

=== /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}] ===

333

334

* **HTTP Method:** GET

335

** **Media types:**

336

*** application/xml (SearchResults element)

337

** **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. The specified keywords are converted to uppercase and used in a HQL LIKE clause (e.g if the scope is ##CONTENT## then the document's content is matched to the specified keywords).{{version since="17.5.0"}}The search for pages by title, name and content is based on Solr by default, the query backend can be changed in the [[configuration>>#HConfiguration]]. When the query is empty and no order field is specified, the last modified pages are returned. Otherwise, pages are sorted by match score when no order field is specified. Matches are based on the provided keywords, for the last part of the query a wildcard search is performed in the title and name scopes to support matching partially typed words.{{/version}}

338

** **Status codes:**

339

*** 200: If the request was successful.

340

341

=== /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] ===

342

343

* **HTTP Method:** GET

344

** **Media types:**

345

*** application/xml (SearchResults element)

346

** **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>>Documentation.DevGuide.Scripting.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. {{version since="17.10.5, 18.2.0"}}By default, only the ##solr## query type is available. Additional query types can be enabled by setting the ##rest.allowedQueryTypes## configuration option in ##xwiki.properties##.{{/version}}

347

** **Status codes:**

348

*** 200: If the request was successful.

349

350

=== /wikimanager (This resource is only available when using the [[multi-wiki>>extensions:Extension.Wiki Application]] feature) ===

351

352

* **HTTP Method:** POST

353

** **Accepted Media types:**

354

*** application/xml (Wiki element)

355

** **Media types:**

356

*** application/xml (Wiki element)

357

** **Query parameters**

358

*** template - the wiki template to be used for initializing the wiki.

359

*** history={RESET/REPLACE/ADD} - history importing

360

** **Description:** create a new wiki.

361

** **Status codes:**

362

*** 200: If the request was successful.

363

364

== Space resources ==

365

366

=== /wikis/{wikiName}/spaces[?start~=offset&number~=n] ===

367

368

* **HTTP Method:** GET

369

** **Media types:**

370

*** application/xml (Spaces element)

371

** **Description:** Retrieves the list of spaces available in the {wikiName} wiki.

372

** **Status codes:**

373

*** 200: If the request was successful.

374

375

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===

376

377

* **HTTP Method:** GET

378

** **Media types:**

379

*** application/xml (Search results element)

380

** **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}

381

** **Status codes:**

382

*** 200: If the request was successful.

383

*** 401: If the user is not authorized.

== Page resources ==

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages[?start~=offset&number~=n] ===

388

389

* **HTTP Method:** GET

390

** **Media types:**

391

*** application/xml (Pages element)

392

** **Description:** The list of pages in the space {spaceName}

393

** **Status codes:**

394

*** 200: If the request was successful.

395

*** 401: If the user is not authorized.

396

397

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}[?prettyNames~={true,false}&objects~={true,false}&class~={true,false}&attachments~={true,false}&minorRevision~={true,false}[&checkRight~={rightName}]*][&supportedSyntax~={syntaxId}]*] ===

398

399

* **HTTP Method:** GET

400

** **Media types:**

401

*** application/xml (Page element)

402

** **Query parameters**

403

*** ##prettyNames##: also return the pretty name for various document information (like the author display name, etc). Disabled by default.

404

*** ##objects##: //[since 7.3M1]// also return the objects. Disabled by default.

405

*** ##class##: //[since 7.3M1]// also return the class. Disabled by default.

406

*** ##attachments##: //[since 7.3M1]// also return the attachments metadatas. Disabled by default.

407

*** {{version since="18.1.0RC1"}}##checkRight##: also return whether the user has the right {rightName} on the page. Multiple checks can be requested. Empty by default.{{/version}}

408

*** {{version since="18.2.0RC1"}}##supportedSyntax##: if set and the pages's syntax is not in the list, also return an HTML rendering of the page. Empty by default.{{/version}}

409

** **Description:**

410

** **Status codes:**

411

*** 200: If the request was successful.

412

*** 401: If the user is not authorized.

413

414

* **HTTP Method:** PUT

415

** **Accepted Media types:**

416

*** application/xml (Page element)

417

*** text/plain (Only page content)

418

*** application/x-www-form-urlencoded (allowed field names: title, parent, hidden //[since 7.3]//, content)

419

** **Media types:**

420

*** application/xml (Page element)

421

** **Query parameters**

422

*** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.

423

** **Description:** Create or updates a page.

424

** **Status codes:**

425

*** 201: If the page was created.

426

*** 202: If the page was updated.

427

*** 304: If the page was not modified.

428

*** 401: If the user is not authorized.

429

430

* **HTTP Method:** DELETE

431

** **Media types:**

432

*** application/xml (Page element)

433

** **Description:** Delete the page.

434

** **Status codes:**

435

*** 204: If the request was successful.

436

*** 401: If the user is not authorized.

437

438

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history[?start~=offset&number~=n] ===

439

440

* **HTTP Method:** GET

441

** **Media types:**

442

*** application/xml (History element)

443

** **Description:** The list of all the versions of the given page.

444

** **Status codes:**

445

*** 200: If the request was successful.

446

*** 401: If the user is not authorized.

447

448

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version} ===

449

450

* **HTTP Method:** GET

451

** **Media types:**

452

*** application/xml (Page element)

453

** **Description:** The page at version {version}

454

** **Status codes:**

455

*** 200: If the request was successful.

456

*** 401: If the user is not authorized.

457

458

==== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations[?start~=offset&number~=n] ====

459

460

* **HTTP Method:** GET

461

** **Media types:**

462

*** application/xml (Translations element)

463

** **Description:** The list of available translation for the page

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/{language}[?minorRevision~={true,false}] ===

469

470

* **HTTP Method:** GET

471

** **Media types:**

472

*** application/xml (Page element)

473

** **Description:** The page at in the given {language}.

474

** **Status codes:**

475

*** 200: If the request was successful.

476

*** 401: If the user is not authorized.

477

478

* **HTTP Method:** PUT

479

** **Accepted Media types:**

480

*** application/xml (Page element)

481

*** text/plain (Only page content)

482

*** application/x-www-form-urlencoded (allowed field names: title, parent, content)

483

** **Media types:**

484

*** application/xml (Page element)

485

** **Query parameters**

486

*** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.

487

** **Description:** Create or updates a page translation.

488

** **Status codes:**

489

*** 201: If the page was created.

490

*** 202: If the page was updated.

491

*** 304: If the page was not modified.

492

*** 401: If the user is not authorized.

493

494

* **HTTP Method:** DELETE

495

** **Media types:**

496

*** application/xml (Page element)

497

** **Description:** Delete the page translation.

498

** **Status codes:**

499

*** 204: If the request was successful.

500

*** 401: If the user is not authorized.

501

502

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations/{language}/history ===

503

504

* **HTTP Method:** GET

505

** **Media types:**

506

*** application/xml (History element)

507

** **Description:** The list of all the available revisions of the page in a given {language}.

508

** **Status codes:**

509

*** 200: If the request was successful.

510

*** 401: If the user is not authorized.

511

512

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations/{lang}/history/{version} ===

513

514

* **HTTP Method:** GET

515

** **Media types:**

516

*** application/xml (Page element)

517

** **Description:** A page at a given {version} in a given {language}.

518

** **Status codes:**

519

*** 200: If the request was successful.

520

*** 401: If the user is not authorized.

521

522

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/children?[start~=0][&number~=-1][&prettyNames~={false,true}][&hierarchy~={parentchild,nestedpages}][&search~=] ===

523

524

* **HTTP Method:** GET

525

** **Media types:**

526

*** application/xml (Pages element)

527

** **Query parameters**

528

*** start={integer} the index of the first child page to return, defaults to 0

529

*** number={integer} the maximum number of child pages to return, defaults to -1 which means no limit

530

*** prettyNames={boolean} whether to include rendered page titles in the response (can slow down the response), defaults to false

531

*** {{version since="16.4.0RC1"}}hierarchy={parentchild,nestedpages} the type of hierarchy to use when searching for child pages; for backwards compatibility, the default hierarchy used is "parentchild"; use "nestedpages" hierarchy if you want results that match the current XWiki UI{{/version}}

532

*** {{version since="16.4.0RC1"}}search={string} a search string to filter the child pages by name or title, defaults to empty string which means no filtering{{/version}}

533

** **Description:** The list of the children of a given page.

534

** **Status codes:**

535

*** 200: If the request was successful.

536

*** 401: If the user is not authorized.

537

538

=== /wikis/{wikiName}/pages[?name~=paneName&space~=spaceName&author~=authorName] ===

539

540

* **HTTP Method:** GET

541

** **Media types:**

542

*** application/xml (Pages element)

543

** **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.

544

** **Status codes:**

545

*** 200: If the request was successful.

546

*** 401: If the user is not authorized.

== Tag resources ==

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/tags[?minorRevision~={true,false}] ===

551

552

* **HTTP Method:** GET

553

** **Media types:**

554

*** application/xml (Tags element)

555

** **Description:** List page tags.

556

** **Status codes:**

557

*** 200: If the request was successful.

558

*** 401: If the user is not authorized.

559

560

* **HTTP Method:** PUT

561

** **Accepted Media types:**

562

*** application/xml (Tag element)

563

*** text/plain

564

*** application/x-www-form-urlencoded (allowed field names: tag)

565

** **Media types:**

566

*** application/xml (Tags element)

567

** **Query parameters**

568

*** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.

569

** **Description:** Add a tag to the page.

570

** **Status codes:**

571

*** 202: If the request was successful.

572

*** 401: If the user is not authorized.

573

574

=== /wikis/{wikiName}/tags ===

575

576

* **HTTP Method:** GET

577

** **Media types:**

578

*** application/xml (Tags element)

579

** **Description:** The list of all available tags

580

** **Status codes:**

581

*** 200: If the request was successful.

582

*** 401: If the user is not authorized.

583

584

=== /wikis/{wikiName}/tags/{tag1}[,{tag2},{tag3}...][?start~=offset&number~=n] ===

585

586

* **HTTP Method:** GET

587

** **Media types:**

588

*** application/xml (Pages element)

589

** **Description:** The list of pages having the specified tags.

590

** **Status codes:**

591

*** 200: If the request was successful.

592

*** 401: If the user is not authorized.

593

594

== Comments resources ==

595

596

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/comments[?start~=offset&number~=n] ===

597

598

* **HTTP Method:** GET

599

** **Media types:**

600

*** application/xml (Comments element)

601

** **Description:** The list of comments on a given page.

602

** **Status codes:**

603

*** 200: If the request was successful.

604

*** 401: If the user is not authorized.

605

606

* **HTTP Method:** POST

607

** **Accepted Media types:**

608

*** application/xml (Comment element)

609

*** text/plain

610

*** application/x-www-form-urlencoded - allowed field names: ##text##, ##replyTo## (object number of the replied comment, since XE 2.3)

611

** **Media types:**

612

*** application/xml (Comment element)

613

** **Description:** Create a comment on the given page.

614

** **Status codes:**

615

*** 201: If the comment was created. (The Location header will contain the URI where the comment has been created.)

616

*** 401: If the user is not authorized.

617

618

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/comments/{commentId} ===

619

620

* **HTTP Method:** GET

621

** **Media types:**

622

*** application/xml (Comment element)

623

** **Description:** A specific comment on a page

624

** **Status codes:**

625

*** 200: If the request was successful.

626

*** 401: If the user is not authorized.

627

628

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/comments ===

629

630

* **HTTP Method:** GET

631

** **Media types:**

632

*** application/xml (Comments element)

633

** **Description:** The list of comments at a specific page {version}.

634

** **Status codes:**

635

*** 200: If the request was successful.

636

*** 401: If the user is not authorized.

637

638

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/comments/{commentId} ===

639

640

* **HTTP Method:** GET

641

** **Media types:**

642

*** application/xml (Comment element)

643

** **Description:** A comment at a specific page {version}.

644

** **Status codes:**

645

*** 200: If the request was successful.

646

*** 401: If the user is not authorized.

647

648

== Attachments resources ==

649

650

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments[?start~=offset&number~=n] ===

651

652

* **HTTP Method:** GET

653

** **Media types:**

654

*** application/xml (Attachments element)

655

** **Description:** The list of attachments of a given page.

656

** **Status codes:**

657

*** 200: If the request was successful.

658

*** 401: If the user is not authorized.

659

660

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName} ===

661

662

* **HTTP Method:** GET

663

** **Media types:**

664

*** The same of the attachment media type.

665

** **Description:** The attachment identified by {attachmentName} on a given page.

666

** **Status codes:**

667

*** 200: If the request was successful.

668

*** 401: If the user is not authorized.

669

670

* **HTTP Method:** PUT

671

** **Accepted media types:**

672

*** **/**

673

** **Media types:**

674

*** application/xml (AttachmentSummary element)

675

** **Description:** Create an attachment identified by {attachmentName} on a given page.

676

** **Status codes:**

677

*** 201: If the attachment was created.

678

*** 202: If the attachment was updated.

679

*** 401: If the user is not authorized.

680

681

* **HTTP Method:** DELETE

682

** **Media types:**

683

** **Description:** Delete the attachment identified by {attachmentName} on a given page.

684

** **Status codes:**

685

*** 204: If the attachment was deleted.

686

*** 401: If the user is not authorized.

687

688

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/attachments[?start~=offset&number~=n] ===

689

690

* **HTTP Method:** GET

691

** **Media types:**

692

*** application/xml (Attachments element)

693

** **Description:** The list of attachments at a given page {version}.

694

** **Status codes:**

695

*** 200: If the request was successful.

696

*** 401: If the user is not authorized.

697

698

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/attachments/{attachmentName} ===

699

700

* **HTTP Method:** GET

701

** **Media types:**

702

*** The same of the attachment media type.

703

** **Description:** The attachment identified by {attachmentName} on a given page {version}.

704

** **Status codes:**

705

*** 200: If the request was successful.

706

*** 401: If the user is not authorized.

707

708

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName}/history ===

709

710

* **HTTP Method:** GET

711

** **Media types:**

712

*** application/xml (Attachments element)

713

** **Description:** The list of available version for the {attachmentName}

714

** **Status codes:**

715

*** 200: If the request was successful.

716

*** 401: If the user is not authorized.

717

718

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName}/history/{version} ===

719

720

* **HTTP Method:** GET

721

** **Media types:**

722

*** The same of the attachment media type.

723

** **Description:** The {attachmentName} at a given {version}

724

** **Status codes:**

725

*** 200: If the request was successful.

726

*** 401: If the user is not authorized.

727

728

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/attachments[?name~=attachmentName&page~=pageName&author~=authorName&types~=attachmentTypeList&start~=offset&number~=n] ===

729

730

* **HTTP Method:** GET

731

** **Media types:**

732

*** application/xml (Attachments element)

733

** **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.

734

** **Status codes:**

735

*** 200: If the request was successful.

736

*** 401: If the user is not authorized.

737

738

=== /wikis/{wikiName}/attachments[?name~=attachmentName&page~=pageName&space~=spaceName&author~=authorName&types~=attachmentTypeList&start~=offset&number~=n] ===

739

740

* **HTTP Method:** GET

741

** **Media types:**

742

*** application/xml (Attachments element)

743

** **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.

744

** **Status codes:**

745

*** 200: If the request was successful.

746

*** 401: If the user is not authorized.

747

748

== Object resources ==

749

750

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects[?start~=offset&number~=n] ===

751

752

* **HTTP Method:** GET

753

** **Media types:**

754

*** application/xml (Objects element)

755

** **Description:** The list of objects associated to a page.

756

** **Status codes:**

757

*** 200: If the request was successful.

758

*** 401: If the user is not authorized.

759

760

* **HTTP Method:** POST

761

** **Accepted media types:**

762

*** application/xml (Object element)

763

*** application/x-www-form-urlencoded (a set of property#name=value pairs representing properties and a field className)

764

**** e.g. {{code language="none"}}className=XWiki.XWikiUsers&property#first_name=John&property#last_name=Doe{{/code}}

765

** **Media types:**

766

*** application/xml (Object element)

767

** **Description:** Create a new object.

768

** **Status codes:**

769

*** 201: If the object was created (The Location header will contain the URI associated to the newly created object).

770

*** 401: If the user is not authorized.

771

772

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}[?start~=offset&number~=n] ===

773

774

* **HTTP Method:** GET

775

** **Media types:**

776

*** application/xml (Objects element)

777

** **Description:** The list of objects of a given {className} associated to a page.

778

** **Status codes:**

779

*** 200: If the request was successful.

780

*** 401: If the user is not authorized.

781

782

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber}[?minorRevision~={true,false}] ===

783

784

* **HTTP Method:** GET

785

** **Media types:**

786

*** application/xml (Object element)

787

** **Description:** The object of type {className} identified by {objectNumber} associated to the given page.

788

** **Status codes:**

789

*** 200: If the request was successful.

790

*** 401: If the user is not authorized.

791

792

* **HTTP Method:** PUT

793

** **Accepted media types:**

794

*** application/xml (Object element)

795

*** application/x-www-form-urlencoded (a set of property#name=value pairs representing properties)

796

** **Media types:**

797

*** application/xml (Object element)

798

** **Query parameters**

799

*** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.

800

** **Description:** Modify the object properties.

801

** **Status codes:**

802

*** 202: If the object was updated.

803

*** 401: If the user is not authorized.

804

805

* **HTTP Method:** DELETE

806

** **Media types:**

807

** **Description:** Delete the object.

808

** **Status codes:**

809

*** 204: If the object was deleted.

810

*** 401: If the user is not authorized.

811

812

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber}/properties ===

813

814

* **HTTP Method:** GET

815

** **Media types:**

816

*** application/xml (Properties element)

817

** **Description:** The properties of the object of type {className} identified by {objectNumber} associated to the given page.

818

** **Status codes:**

819

*** 200: If the request was successful.

820

*** 401: If the user is not authorized.

821

822

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber}/properties/{propertyName}[?minorRevision~={true,false}] ===

823

824

* **HTTP Method:** GET

825

** **Media types:**

826

*** application/xml (Properties element)

827

** **Description:** The property {propertyname} of the object of type {className} identified by {objectNumber} associated to the given page.

828

** **Status codes:**

829

*** 200: If the request was successful.

830

*** 401: If the user is not authorized.

831

832

* **HTTP Method:** PUT

833

** **Accepted media types:**

834

*** application/xml (Property element)

835

*** text/plain

836

*** application/x-www-form-urlencoded (a field property#name=value pairs representing a property)

837

** **Media types:**

838

*** application/xml (Property element)

839

** **Query parameters**

840

*** ##minorRevision## ({{info}}Since 9.11.4 & 10.2RC1{{/info}}): Create a minor revision for the page. Disabled by default.

841

** **Description:** Modify the object properties.

842

** **Status codes:**

843

*** 202: If the object was updated.

844

*** 401: If the user is not authorized.

845

846

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects[?start~=offset&number~=n] ===

847

848

* **HTTP Method:** GET

849

** **Media types:**

850

*** application/xml (Objects element)

851

** **Description:** The list of objects associated to a page at a given {version}.

852

** **Status codes:**

853

*** 200: If the request was successful.

854

*** 401: If the user is not authorized.

855

856

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber} ===

857

858

* **HTTP Method:** GET

859

** **Media types:**

860

*** application/xml (Object element)

861

** **Description:** The object of type {className} identified by {objectNumber} associated to the given page at a given {version}.

862

** **Status codes:**

863

*** 200: If the request was successful.

864

*** 401: If the user is not authorized.

865

866

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties ===

867

868

* **HTTP Method:** GET

869

** **Media types:**

870

*** application/xml (Properties element)

871

** **Description:** The properties of the object of type {className} identified by {objectNumber} associated to the given page at a given {version}.

872

** **Status codes:**

873

*** 200: If the request was successful.

874

*** 401: If the user is not authorized.

875

876

=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties/{propertyName} ===

877

878

* **HTTP Method:** GET

879

** **Media types:**

880

*** application/xml (Properties element)

881

** **Description:** The property {propertyName} of the object of type {className} identified by {objectNumber} associated to the given page at a given {version}.

882

** **Status codes:**

883

*** 200: If the request was successful.

884

*** 401: If the user is not authorized.

885

886

=== /wikis/{wikiName}/classes/{className}/objects[?start~=offset&number~=n] ===

887

888

* **HTTP Method:** GET

889

** **Media types:**

890

*** application/xml (Objects element)

891

** **Description:** The list of all the objects of a given {className}.

892

** **Status codes:**

893

*** 200: If the request was successful.

894

*** 401: If the user is not authorized.

895

896

== Class resources ==

897

898

=== /wikis/{wikiName}/classes[?start~=offset&number~=n] ===

899

900

* **HTTP Method:** GET

901

** **Media types:**

902

*** application/xml (Classes element)

903

** **Description:** The list of all the classes defined in the wiki {wikiName}

904

** **Status codes:**

905

*** 200: If the request was successful.

906

*** 401: If the user is not authorized.

907

908

=== /wikis/{wikiName}/classes/{className} ===

909

910

* **HTTP Method:** GET

911

** **Media types:**

912

*** application/xml (Class element)

913

** **Description:** The {className} definition

914

** **Status codes:**

915

*** 200: If the request was successful.

916

*** 401: If the user is not authorized.

917

918

=== /wikis/{wikiName}/classes/{className}/properties ===

919

920

* **HTTP Method:** GET

921

** **Media types:**

922

*** application/xml (Properties element)

923

** **Description:** The properties of the class {className}.

924

** **Status codes:**

925

*** 200: If the request was successful.

926

*** 401: If the user is not authorized.

927

928

=== /wikis/{wikiName}/classes/{className}/properties/{propertyName} ===

929

930

* **HTTP Method:** GET

931

** **Media types:**

932

*** application/xml (Property element)

933

** **Description:** The property {propertyName} of the class {className}.

934

** **Status codes:**

935

*** 200: If the request was successful.

936

*** 401: If the user is not authorized.

937

938

=== /wikis/{wikiName}/classes/{className}/properties/{propertyName}/values {{info}}Since 9.8RC1{{/info}} ===

Request parameters:

|=Name|=Description|

|limit|Limit the number of values returned. Zero or a negative number means no limit.

944

|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.

945

946

* **HTTP Method:** GET

947

** **Media types:**

948

*** application/xml (Property element)

949

** **Description:** The list of values for the property {propertyName} of the class {className}. At the moment only Database List properties are supported.

950

** **Status codes:**

951

*** 200: If the request was successful.

952

*** 401: If the user is not authorized to view the specified property.

953

*** 404: If the specified property doesn't exist.

== Job resources ==

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##).

958

959

=== /jobstatus/{jobId} {{info}}Since 7.2M3{{/info}} ===

Request parameters:

|##log##|no|##true~|false##|##false##|Return also the job log|9.1RC1

967

968

969

* **HTTP Method:** GET

970

** **Media types:**

971

*** application/xml (JobStatus element)

972

** **Description:** status of a job

973

** **Status codes:**

974

*** 200: If the request was successful.

975

*** 404: If the job status has not been found

976

977

=== /joblog/{jobId} {{info}}Since 7.2M3{{/info}} ===

Request parameters:

* **HTTP Method:** GET

986

** **Media types:**

987

*** application/xml (JobLog element)

988

** **Description:** log of a job

989

** **Status codes:**

990

*** 200: If the request was successful.

991

*** 404: If the job status has not been found

992

993

=== /jobs {{info}}Since 9.1RC1{{/info}} ===

Request parameters:

|##jobType##|yes| | |The type of the job to pass to the Job Executor|9.1RC1

999

1000

1001

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.).

1002

1003

* **HTTP Method:** PUT

1004

** **Input:**

1005

*** Media Types: ##application/xml## or ##application/json##

1006

*** Input body: ##JobRequest## element

1007

** **Output:**

1008

*** Media Types: ##application/xml## or ##application/json##

1009

*** Response body: ##JobStatus## element

1010

** **Description:** Start a new job synchronously or asynchronously

1011

** **Status codes:**

1012

*** 200: If the job was successfully executed

1013

*** 401: If the user is not authorized (i.e. doesn't have Programming Rights)

1014

*** 500: Failing jobs with ##async=false## return an error 500 (Since 9.7RC1)

1015

1016

Jobs started through the REST API automatically get their runtime context injected with the following REST HTTP request context properties:

* current wiki

* current user

* request URL and parameters

1021

1022

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:

1023

1024

* ask for the status of an existing job to have an hint of how the XML/JSON should look like (see [[jobstatus section>>#H2Fjobstatus2F7BjobId7D]])

1025

* 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/

1026

1027

=== Example of Extension Manager installJob ===

1028

1029

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):

1030

1031

1032

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

1033

1034

1035

== Localization resources ==

1036

1037

For more details see the [[Localization Module documentation>>extensions:Extension.Localization.WebHome]].

1038

1039

1040

=== /wikis/{wikiName}/localization/translations[?locale~=l&prefix~=p[&key~=k]*] ===

1041

1042

* **HTTP Method**: GET

1043

** **Media Types:** ##application/xml## or ##application/json##

1044

** **Description: **The list of translations of the requested keys in a given locale

1045

** **Query Parameters:**

1046

*** **locale:** (optional) the locale of the returned translation, if missing the locale is resolved from the context

1047

*** **prefix:** (optional) a common prefix concatenated to all the provided keys.

1048

*** **key:** (multiple) a list of translation keys

1049

** **Status Code:**

1050

*** 200: if the request was successful

1051

** **Response:**

1052

*** 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).

1053

1054

1055

== Icon Theme resources ==

1056

1057

For more details see the [[Icon Theme Application>>extensions:Extension.Icon Theme Application]].

1058

1059

1060

=== /wikis/{wikiName}/iconThemes/icons[?[name~=n]*] ===

1061

1062

* **HTTP Method**: GET

1063

** **Media Types:** ##application/xml## or ##application/json##

1064

** **Description: **Provides the metadata of the icons of the current icon theme in a given ##{wikiName}## wiki

1065

** **Query Parameters:**

1066

*** **name:** (multiple) the name of the requested icons

1067

** **Status Code:**

1068

*** 200: if the request was successful

1069

** **Response:**

1070

*** 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.

1071

1072

=== /wikis/{wikiName}/iconThemes/{iconTheme}/icons[?[name~=n]*] ===

1073

1074

* **HTTP Method**: GET

1075

** **Media Types:** ##application/xml## or ##application/json##

1076

** **Description: **Provides the metadata of the icons of the ##{iconTheme}## icon theme in a given ##{wikiName}## wiki

1077

** **Query Parameters:**

1078

*** **name:** (multiple) the name of the requested icons

1079

** **Status Code:**

1080

*** 200: if the request was successful

1081

** **Response:**

1082

*** 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.

== User resources ==

=== /wikis/{wikiName}/user[?preferences~={true,false}] ===

1089

1090

* **HTTP Method:** GET

1091

** **Media types:**

1092

*** application/xml (User element)

1093

** **Query parameters:**

1094

*** ##preferences##: also return the preferences. Disabled by default.

1095

** **Description:** The user performing the request

1096

** **Status codes:**

1097

*** 200: If the request was successful.

1098

*** 401: If the user is not authorized on {wikiName}.

1099

1100

=== /wikis/{wikiName}/users/{userId}[?preferences~={true,false}] ===

1101

1102

* **HTTP Method:** GET

1103

** **Media types:**

1104

*** application/xml (User element)

1105

** **Query parameters:**

1106

*** ##preferences##: also return the preferences. Disabled by default and might require specific rights.

1107

** **Description:** The user that corresponds to {userId} when resolved from {wikiName}. The format of {userId} is intentionally left unspecified and depends on the available resolvers on the instance. For example, with a user stored as a document ##XWiki.someUser## on the default wiki, {userId} could be either ##someUser## or one of the more technical syntaxes listed in the [[User API documentation>>extensions:Extension.User Module.API.WebHome#HBridge]].

1108

** **Status codes:**

1109

*** 200: If the request was successful.

1110

*** 401: If the user is not authorized on {wikiName} or does not have access to the requested user's profile.

1111

*** 404: If the requested user could not be found.

1112

1113

1114

== Other resources ==

1115

1116

=== /wikis/{wikiName}/modifications[?start~=offset&number~=n&date~=t] ===

1117

1118

* **HTTP Method:** GET

1119

** **Media types:**

1120

*** application/xml (Modifications element)

1121

** **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)

1122

** **Status codes:**

1123

*** 200: If the request was successful.

1124

*** 401: If the user is not authorized.

= Custom resources =

== In Wiki Pages ==

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:

#if ("$!request.space" != '')

1135

#set ($discard = $response.setContentType('text/xml'))

1136

1137

<pages>

1138

#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"))

1139

#set ($spaceReferenceString = $request.space)

1140

#set ($spaceLike = $spaceReferenceString.replaceAll('([%_!])', '!$1').concat('.%'))

1141

#set ($query = $query.bindValue('spacelike', $spaceLike))

1142

#set ($query = $query.bindValue('space', $spaceReferenceString))

1143

#foreach ($item in $query.execute())

#end

</pages>

#end

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:

<pages>

<page>Sandbox.Test.WebHome</page>

1156

<page>Sandbox.TestPage2</page>

1157

<page>Sandbox.ApplicationsPanelEntry</page>

1158

<page>Sandbox.TestPage3</page>

1159

<page>Sandbox.TestPage1</page>

1160

<page>Sandbox.WebPreferences</page>

1161

<page>Sandbox.WebHome</page>

</pages>

== In Java ==

It's possible to easily add any REST resource by registering a ##org.xwiki.rest.XWikiResource## java component on your wiki (see [[Component guide>>Documentation.DevGuide.Tutorials.WritingComponents]] for more details).

1168

1169

1170

package org.xwiki.contrib.rest;

1171

1172

import javax.ws.rs.DefaultValue;

1173

import javax.ws.rs.GET;

1174

import javax.ws.rs.Path;

1175

1176

import org.xwiki.component.annotation.Component;

1177

import org.xwiki.rest.XWikiResource;

1178

1179

@Component("org.xwiki.contrib.rest.HelloWorldResource")

1180

@Path("/myresources/{myresourcename}")

1181

public class HelloWorldResource extends XWikiResource {

1182

@GET

1183

public String get(@PathParam("myresourcename") @DefaultValue("world") String myresourcename)

1184

{

1185

return "Hello " + myresourcename;

}

}

The name of the component has to be the class FQN.

1191

1192

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]].

1193

1194

The resource is expected to follow JAX-RS 1 specifications before XWiki 16.2.0 and JAX-RS 2.1 starting with XWiki 16.2.0.

1195

1196

Starting from release 4.3M2, the RESTful API modules have been refactored so that now resource declarations are available in a separate module.

1197

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.

1198

1199

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:

1200

1201

* Another platform module that wants to generate responses with links to existing resources.

1202

* HTTP clients that wants to make requests to the RESTful API.

1203

1204

The xwiki-platform-rest-api module can be also seen as an authoritative reference for the REST API.

1205

1206

= Generate a REST URL for a resource =

1207

1208

If you need to generate a REST URL as String for a resource inside a script, you can use the REST script services:

1209

1210

1211

## Return a relative URL String unless the reference wiki is different from the current wiki

1212

$services.rest.url($entityReference)

1213

1214

## Force returning an external form URL String, false as second parameter would have the same effect that the previous call

1215

$services.rest.url($entityReference, true)

1216

1217

## String parameter automaticallly converter to entity reference

1218

$services.rest.url('MySpace.MyPage')

1219

$services.rest.url('document:MySpace.MyPage')

1220

$services.rest.url('space:MySpace')

1221

1222

1223

Where ##$entityReference## could be:

1224

1225

* a ##DocumentReference##

1226

* a ##SpaceReference##

1227

1228

We plan to add more supported entities in the future (ObjectReference, ClassReference, etc...).

1229

1230

= Using the RESTful API =

1231

1232

1233

The examples below are using the ##~-~-data## (##-d##) parameter of the curl command to provide the data sent with the request, which may do some alteration on the content being actually sent (newlines, character set, etc.)

1234

There may be cases where you may need / want to use the ##~-~-data-binary## parameter, in order to send the data as-is, especially when manipulating page content, in which the newlines are relevant.

== Tutorial ==

See [[this tutorial>>http://blog.fabio.mancinelli.me/2011/03/07/XWikis_RESTful_API.html]] by Fabio Mancinelli.

1240

1241

== Creating an XWiki Object ==

1242

1243

In this example we will use the [[curl>>http://curl.haxx.se/]] utility as the HTTP client.

1244

1245

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##.

1246

1247

So, on the command line, you have to do the following:

1248

1249

1250

$ curl -u Admin:admin

1251

-X POST

1252

-H "Content-type: application/xml"

1253

-H "Accept: application/xml"

1254

-d "@test.xml"

1255

http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects

1256

1257

1258

where ##test.xml## is:

<className>XWiki.TestClass</className>

1263

1264

<value>Whatever you want to put here</value>

</property>

</object>

Alternatively you can use the less verbose ##application/x-www-form-urlencoded format##:

1270

1271

1272

$ curl -u Admin:admin

1273

-X POST

1274

-H "Content-type: application/x-www-form-urlencoded"

1275

-H "Accept: application/xml"

1276

-d "@test.txt"

1277

http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects

1278

1279

1280

where ##test.txt## contains something like:

1281

1282

1283

className=XWiki.TestClass&property#test=Whatever+you+want

1284

1285

1286

Or, better, you can use directly curl to specify these parameters

1287

using multiple ##-d## switches:

1288

1289

1290

$ curl -u Admin:admin

1291

-X POST -H "Content-type: application/x-www-form-urlencoded"

1292

-H "Accept: application/xml"

1293

-d "className=XWiki.TestClass"

1294

-d "property#test=Whatever you want"

1295

http://localhost/xwiki/rest/wikis/xwiki/spaces/Test/pages/Test/objects

1296

1297

1298

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.

=== Remarks: ===

* 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.

1303

1304

* The information you get back when you retrieve an object (i.e., all

1305

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.

1306

1307

* 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.

1308

1309

== Formats of files ==

1310

1311

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).

1312

1313

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.

1314

1315

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.

1316

1317

=== Example of a file for a ##wiki## ===

<id>xwiki</id>

<name>xwiki</name>

<description>Some description of the wiki</description>

<owner>Admin</owner>

</wiki>

=== Example of a file for a ##space## ===

<id>xwiki:Main</id>

<wiki>xwiki</wiki>

<home>xwiki:Main.WebHome</home>

1338

<xwikiRelativeUrl>http://localhost:8080/xwiki/bin/view/Main/</xwikiRelativeUrl>

1339

<xwikiAbsoluteUrl>http://localhost:8080/xwiki/bin/view/Main/</xwikiAbsoluteUrl>

</space>

=== Example of a file for a ##page## ===

<id>xwiki:Main.WebHome</id>

1349

<fullName>Main.WebHome</fullName>

<wiki>xwiki</wiki>

<name>WebHome</name>

<author>XWiki.Admin</author>

1358

<authorName>Administrator</authorName>

1359

<xwikiRelativeUrl>http://localhost:8080/xwiki/bin/view/Main/</xwikiRelativeUrl>

1360

<xwikiAbsoluteUrl>http://localhost:8080/xwiki/bin/view/Main/</xwikiAbsoluteUrl>

1361

1362

<syntax>xwiki/2.0</syntax>

<hidden>false</hidden>

1367

1368

<creator>XWiki.Admin</creator>

1369

<creatorName>Administrator</creatorName>

1370

1371

<modifier>XWiki.Admin</modifier>

1372

<modifierName>Administrator</modifierName>

1373

<comment>Imported from XAR</comment>

1374

<content>{{include reference="Dashboard.WebHome" context="new"/}}</content>

</page>

=== Example of a file for a ##tag## ===

1379

1380

1381

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

</tags>

=== Example of a file for a ##comment## ===

1388

1389

1390

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<pageId>xwiki:Main.WebHome</pageId>

1395

<author>XWiki.Admin</author>

1396

<authorName>Administrator</authorName>

1397

1398

1399

<text>This is a comment</text>

</comment>

</comments>

=== Example of a file for an ##object## ===

1406

1407

1408

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

1409

1410

<id>xwiki:Main.WebHome:c170a0a8-cc17-41cd-aa1e-6f6faf1d9f28</id>

1411

1412

<pageId>xwiki:Main.WebHome</pageId>

<wiki>xwiki</wiki>

<pageName>WebHome</pageName>

1417

<pageAuthor>XWiki.superadmin</pageAuthor>

1418

<className>XWiki.EditModeClass</className>

</property>

</object>

=== Example of a file for a ##property## ===

1434

1435

1436

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

</property>

= Examples =

== Getting the list of users ==

1451

1452

Since Users are stored as Objects, you can do a search of the type ##XWiki.XWikiUsers##. For example:

1453

1454

1455

http://<server>/xwiki/rest/wikis/query?q=object:XWiki.XWikiUsers

1456

1457

1458

== Getting the list of users using XWQL ==

1459

1460

Using the parameter "className" the result includes the data for the first object of the ##XWiki.XWikiUsers##:

1461

1462

1463

http://<server>/xwiki/rest/wikis/xwiki/query?q=,doc.object(XWiki.XWikiUsers) as obj&type=xwql&className=XWiki.XWikiUsers

1464

1465

1466

== Getting the list of inactive users using XWQL ==

1467

1468

Using the property "active" where the value is 0 (by replacing with value 1 result will include active users) the result includes the data for all objects of the ##XWiki.XWikiUsers##:

1469

1470

1471

http://<server>/xwiki/rest/wikis/xwiki/query?q=where doc.object(XWiki.XWikiUsers).active=0&type=xwql&className=XWiki.XWikiUsers

= Configuration =

You can configure the backend that is used for keyword search at the [[wiki>>#H2Fwikis2F7BwikiName7D2Fsearch3Fq3D7Bkeywords7D5B5B26scope3D7Bname2Ccontent2Ctitle2Cobjects7D...5D26start3Dn5D5B26number3Dn5D5B26orderField3Dfield26order3D7Basc2Cdesc7D5D5Bdistinct3D7Btrue2Cfalse7D5D5B26prettyNames3D7Btrue2Cfalse7D5D]] and [[space>>#H2Fwikis2F7BwikiName7D2Fspaces2F7BspaceName7D5B2Fspaces2F7BnestedSpaceName7D5D2A2Fsearch3Fq3D7Bkeywords7D5B5B26scope3D7Bname2Ccontent2Ctitle2Cobjects7D...5D26number3Dn5D]] level in the ##xwiki.properties## configuration file. By default, the backend is Solr as it is more scalable in particular for big installations with more than 100k documents in a single wiki. For backwards-compatibility, you can change the backend to "database" to restore the exact behavior from before XWiki 17.5.0:

#-# [Since 17.5.0]

#-# The default source for keyword search results at the space and wiki level in the REST API.

1482

#-# Supported values: database, solr

1483

#-# Before 17.5.0, the database provided the search results. Since 17.5.0, the default "solr" source is the default

1484

#-# which provides much better performance in particular for large installations and allows more flexible queries.