Wiki source code of The XWiki RESTful API

Version 20.2 by Sergiu Dumitriu on 2010/12/04

version	line-number	content
20.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc depth="2"/}}
	3	{{/box}}
1.1	4
10.5	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.
1.1	6
20.1	7	= Accessing the service =
16.1	8
17.1	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.2	17	All the resource references described in the [[XWiki RESTful API Documentation>>#HXWikiRESTfulAPIDocumentation]] should be intended relative to this URL.
17.1	18
20.1	19	For example the, the ##/wikis## resources on a server running on ##localhost## on port ##8080## can be retrieved using the following URL : ##http:~/~/localhost:8080/xwiki/rest/wikis##
17.1	20
14.2	21	= Dataset =
1.1	22
	23	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.
	24
10.3	25	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.
1.1	26
14.2	27	= Understanding resources and representations =
1.1	28
10.4	29	"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#REST.27s_central_principle:_resources]])
1.1	30
9.1	31	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 that can be found here: [[http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-rest/src/main/resources/xwiki.rest.model.xsd]]
1.1	32
10.4	33	Of course the same resource can be represented in many different ways. This is yet to be documented.
1.1	34
10.4	35	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.
9.2	36
1.1	37	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.
9.2	38
9.1	39	[[image:representation\|\|height="430"]]
1.1	40
14.2	41	== Relations ==
1.1	42
5.1	43	The available relations that you might find in the XML resource representations are the following:
1.1	44
9.1	45	\|=Rel\|=Semantics
15.1	46	\|{{{http://www.xwiki.org/rel/wikis}}}\|The representation containing the list of virtual wikis.
	47	\|{{{http://www.xwiki.org/rel/spaces}}}\|The representation containing the list of spaces in a wiki.
	48	\|{{{http://www.xwiki.org/rel/pages}}}\|The representation containing the list of pages in a space.
	49	\|{{{http://www.xwiki.org/rel/translation}}}\|The representation containing a translation of a page.
	50	\|{{{http://www.xwiki.org/rel/page}}}\|The representation for a page.
	51	\|{{{http://www.xwiki.org/rel/space}}}\|The representation for a space.
	52	\|{{{http://www.xwiki.org/rel/parent}}}\|The representation for the page that is parent of the current resource.
	53	\|{{{http://www.xwiki.org/rel/home}}}\|The representation for the page that is the home of the current resource.
	54	\|{{{http://www.xwiki.org/rel/attachmentData}}}\|The representation of the actual attachment data.
	55	\|{{{http://www.xwiki.org/rel/comments}}}\|The representation of the list of comments associated to the current resource.
	56	\|{{{http://www.xwiki.org/rel/attachments}}}\|The representation of the list of attachments associated to the current resource.
	57	\|{{{http://www.xwiki.org/rel/objects}}}\|The representation of the list of objects associated to the current resource.
	58	\|{{{http://www.xwiki.org/rel/object}}}\|The representation for an object.
	59	\|{{{http://www.xwiki.org/rel/classes}}}\|The representation of the list of classes associated to the current resource.
	60	\|{{{http://www.xwiki.org/rel/history}}}\|The representation of the list of history information associated to the current resource.
	61	\|{{{http://www.xwiki.org/rel/class}}}\|The representation for a class.
	62	\|{{{http://www.xwiki.org/rel/property}}}\|The representation for a property.
	63	\|{{{http://www.xwiki.org/rel/properties}}}\|The representation of the list of properties associated to the current resource.
	64	\|{{{http://www.xwiki.org/rel/modifications}}}\|The representation of the list of modifications associated to the current resource.
	65	\|{{{http://www.xwiki.org/rel/children}}}\|The representation of the list of children associated to the current resource.
	66	\|{{{http://www.xwiki.org/rel/tags}}}\|The representation of the list of tags associated to the current resource.
	67	\|{{{http://www.xwiki.org/rel/tag}}}\|The representation of a tag.
	68	\|{{{http://www.xwiki.org/rel/search}}}\|The representation for a search resource.
9.2	69
8.3	70	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).
1.1	71
14.2	72	== The "HATEOAS" Graph ==
1.1	73
20.1	74	In order to better understand the relations among resources you might have a look at this [[graph>>attach:XWikiHATEOAS.pdf]] that pictures all the resources available in the XWiki RESTful API and the relations among them. In this graph, nodes are [[URI templates>>http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.txt]] representing classes of resources. Edges are the possible links that you might find in a representation of a given resource, and their associated relations.
9.2	75
1.1	76	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.
	77
14.2	78	= Interacting with the XWiki RESTful API =
8.2	79
9.5	80	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!
9.1	81	If you want to write more complex programs you might download an HTTP library for your favorite language (e.g., [[http://hc.apache.org/]]).
9.2	82
9.1	83	Java users might take advantage of the [[JAXB>>https://jaxb.dev.java.net]] framework and its [[XJC binding compiler>>https://jaxb.dev.java.net/jaxb20-ea3/docs/xjc.html]] in order to generate domain object models directly from the [[XML Schema Definition>>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-rest/src/main/resources/xwiki.rest.model.xsd]], and use them for serializing and de-serializing XML representations.
9.2	84
5.1	85	If you use this approach (Apache HTTP Client + JAXB) you will find yourself writing some code like this:
1.1	86
19.1	87	{{code language="java"}}
	88	import javax.xml.bind.JAXBContext;
	89	import javax.xml.bind.Unmarshaller;
	90
	91	import org.apache.commons.httpclient.HttpClient;
	92	import org.apache.commons.httpclient.methods.GetMethod;
	93	import org.xwiki.rest.model.jaxb.Page;
	94
	95	...
1.1	96	HttpClient httpClient = new HttpClient();
18.1	97	JAXBContext context = JAXBContext.newInstance("org.xwiki.rest.model.jaxb");
19.1	98	Unmarshaller unmarshaller = context.createUnmarshaller();
1.1	99
	100	GetMethod getMethod = new GetMethod("http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome");
	101	getMethod.addRequestHeader("Accept", "application/xml");
	102	httpClient.executeMethod(getMethod);
	103
	104	Page page = (Page) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
9.1	105	{{/code}}
1.1	106
5.1	107	And you will have all the information about the Main.WebHome page in the Page object, without the need of handling XML directly.
9.2	108
9.1	109	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.
9.2	110
5.1	111	By using curl, the previous example would have been:
1.1	112
19.1	113	{{code language="xml"}}
1.1	114	$ curl http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome
	115	<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	116	<page xmlns="http://www.xwiki.org">
	117	<link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
	118	...
9.1	119	{{/code}}
1.1	120
14.2	121	== Authentication ==
1.1	122
5.1	123	The XWiki RESTful API supports two types of authentication:
1.1	124
9.1	125	* HTTP BASIC Auth: You provide your credentials using the Authorization HTTP header
	126	* 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.
9.2	127
5.1	128	If you don't provide any credentials the XWiki RESTful API will recognize you as a XWiki.Guest user.
9.2	129
5.1	130	So if you have, let's say a Main.PrivatePage, and you try to do:
1.1	131
10.6	132	{{code language="none"}}
1.1	133	$ curl -v http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/PrivatePage
	134	...
	135	< HTTP/1.1 401 Unauthorized
	136	...
9.1	137	{{/code}}
1.1	138
9.3	139	You will get an Unauthorized empty response.
9.2	140
1.1	141	On the contrary, by specifying Admin credentials you gain access to the actual page:
	142
19.1	143	{{code language="xml"}}
1.1	144	$ curl -u Admin:admin http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main/pages/PrivatePage
	145	<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	146	<page xmlns="http://www.xwiki.org">
	147	<link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
	148	...
	149	<content>Only admin can see this</content>
	150	</page>
9.1	151	{{/code}}
1.1	152
14.2	153	== Sending representations ==
1.1	154
	155	Many resources are modifiable, so you can send representations in order to change the state of those resources (e.g., pages).
9.1	156	All modifiable resources accept XML representations that conform to the [[XML Schema Definition>>http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-rest/src/main/resources/xwiki.rest.model.xsd]]. However, some other representations might be accepted as well (see the following sections).
9.2	157
1.1	158	Resource update is usually done by using the PUT method, while resource creation is done via PUT or POST.
9.2	159
1.1	160	For example, in order to create a page you might do the following:
	161
19.1	162	{{code language="xml"}}
20.2	163	$ 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
1.1	164	<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	165	<page xmlns="http://www.xwiki.org">
	166	<link rel="http://www.xwiki.org/rel/space" href="http://localhost:8080/xwiki/rest/wikis/xwiki/spaces/Main"/>
	167	...
	168	<version>1.1</version>
	169	<majorVersion>1</majorVersion>
	170	<minorVersion>1</minorVersion>
	171	<created>2009-03-21+01:00</created>
	172	<creator>XWiki.Admin</creator>
	173	<modified>2009-03-21+01:00</modified>
	174	<modifier>XWiki.Admin</modifier>
	175	<content>This is a new page</content>
	176	</page>
9.1	177	{{/code}}
1.1	178
	179	Where newpage.xml is an XML file containing
	180
19.1	181	{{code language="xml"}}
1.1	182	<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	183	<page xmlns="http://www.xwiki.org">
	184	<title>Hello world</title>
	185	<content>This is a new page</content>
	186	</page>
9.1	187	{{/code}}
1.1	188
	189	The page has been created and is accessible. Subsequent PUT requests to the page URI will modify its content.
	190
14.2	191	== Overcoming browser limitations ==
1.1	192
10.4	193	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.
9.2	194
10.4	195	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.
1.1	196
	197	This overriding mechanism allows the interaction with the XWiki RESTful API by using any kind of browser.
	198
14.2	199	== PUT vs POST ==
1.1	200
10.4	201	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.
1.1	202
10.4	203	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.
1.1	204
9.5	205	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.
1.1	206
14.2	207	= XWiki RESTful API Documentation =
8.4	208
9.5	209	In this section you will find the documentation of the whole XWiki RESTful API.
1.1	210
9.1	211	application/xml representations refers to the XML Schema Definition at the following location: [[http://svn.xwiki.org/svnroot/xwiki/platform/core/trunk/xwiki-rest/src/main/resources/xwiki.rest.model.xsd]]
1.1	212
9.1	213	Resource URIs are specified using [[URI templates>>http://bitworking.org/projects/URI-Templates/spec/draft-gregorio-uritemplate-03.txt]]. Bracketed elements are formal parameters and should be instantiated to actual values in order to retrieve the associated resource.
1.1	214
14.2	215	== Root resources ==
1.1	216
20.1	217	By defaut all the resources of the RESTful API are rooted at the following URI: ##http:~/~/server:port/xwiki/rest/## (depending on where your XWiki is running)
16.1	218
14.2	219	=== / ===
9.1	220
	221	* HTTP Method: GET
	222	Media types:**
1.1	223	*** application/xml (XWiki element)
9.1	224	Description:** Retrieves the entry root description containing information about the server.
	225	Status codes:**
1.1	226	*** 200: If the request was successful.
	227
14.2	228	=== /wikis ===
9.1	229
	230	* HTTP Method: GET
	231	Media types:**
1.1	232	*** application/xml (Wikis element)
9.1	233	Description:** Retrieves the entry root description containing information about the server.
	234	Status codes:**
1.1	235	*** 200: If the request was successful.
	236
20.1	237	=== /wikis/{wikiName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===
9.1	238
	239	* HTTP Method: GET
	240	Media types:**
1.1	241	*** application/xml (SearchResults element)
9.1	242	Description:** The list of pages and objects that contain the {keywords} in the specified {scope}s. Multiple scopes can be specified. Search results are relative to the whole {wikiName}
	243	Status codes:**
1.1	244	*** 200: If the request was successful.
	245
14.2	246	== Space resources ==
1.1	247
14.2	248	=== /wikis/{wikiName}/spaces[?start~=offset&number~=n] ===
9.1	249
	250	* HTTP Method: GET
	251	Media types:**
1.1	252	*** application/xml (Spaces element)
9.1	253	Description:** Retrieves the list of spaces available in the {wikiName} wiki.
	254	Status codes:**
1.1	255	*** 200: If the request was successful.
	256
20.1	257	=== /wikis/{wikiName}/spaces/{spaceName}/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===
9.1	258
	259	* HTTP Method: GET
	260	Media types:**
1.1	261	*** application/xml (Search results element)
9.1	262	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}
	263	Status codes:**
1.1	264	*** 200: If the request was successful.
	265	*** 401: If the user is not authorized.
	266
14.2	267	== Page resources ==
1.1	268
14.2	269	=== /wikis/{wikiName}/spaces/{spaceName}/pages[?start~=offset&number~=n] ===
9.1	270
	271	* HTTP Method: GET
	272	Media types:**
1.1	273	*** application/xml (Pages element)
9.1	274	Description:** The list of pages in the space {spaceName}
	275	Status codes:**
1.1	276	*** 200: If the request was successful
	277	*** 401: If the user is not authorized.
	278
14.2	279	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName} ===
9.1	280
	281	* HTTP Method: GET
	282	Media types:**
1.1	283	*** application/xml (Page element)
9.1	284	Description:**
	285	Status codes:**
1.1	286	*** 200: If the request was successful.
	287	*** 401: If the user is not authorized.
9.1	288
	289	\\
	290
	291	* HTTP Method: PUT
	292	Accepted Media types:**
1.1	293	*** application/xml (Page element)
	294	*** text/plain (Only page content)
	295	*** application/x-www-form-urlencoded (allowed field names: title, parent, content)
9.1	296	Media types:**
1.1	297	*** application/xml (Page element)
9.1	298	Description:** Create or updates a page.
	299	Status codes:**
1.1	300	*** 201: If the page was created.
	301	*** 202: If the page was updated.
	302	*** 304: If the page was not modified.
	303	*** 401: If the user is not authorized.
9.1	304
	305	\\
	306
	307	* HTTP Method: DELETE
	308	Media types:**
1.1	309	*** application/xml (Page element)
9.1	310	Description:** Delete the page.
	311	Status codes:**
1.1	312	*** 204: If the request was successful.
	313	*** 401: If the user is not authorized.
	314
14.2	315	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history[?start~=offset&number~=n] ===
9.1	316
	317	* HTTP Method: GET
	318	Media types:**
1.1	319	*** application/xml (History element)
9.1	320	Description:** The list of all the versions of the given page.
	321	Status codes:**
1.1	322	*** 200: If the request was successful.
	323	*** 401: If the user is not authorized.
	324
14.2	325	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version} ===
9.1	326
	327	* HTTP Method: GET
	328	Media types:**
1.1	329	*** application/xml (Page element)
9.1	330	Description:** The page at version {version}
	331	Status codes:**
1.1	332	*** 200: If the request was successful.
	333	*** 401: If the user is not authorized.
	334
10.1	335	==== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/translations[?start~=offset&number~=n] ====
9.1	336
	337	* HTTP Method: GET
	338	Media types:**
1.1	339	*** application/xml (Translations element)
9.1	340	Description:** The list of available translation for the page
	341	Status codes:**
1.1	342	*** 200: If the request was successful.
	343	*** 401: If the user is not authorized.
	344
14.2	345	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/translations/{language} ===
9.1	346
	347	* HTTP Method: GET
	348	Media types:**
1.1	349	*** application/xml (Page element)
9.1	350	Description:** The page at in the given {language}.
	351	Status codes:**
1.1	352	*** 200: If the request was successful.
	353	*** 401: If the user is not authorized.
9.1	354
	355	\\
	356
	357	* HTTP Method: PUT
	358	Accepted Media types:**
1.1	359	*** application/xml (Page element)
	360	*** text/plain (Only page content)
	361	*** application/x-www-form-urlencoded (allowed field names: title, parent, content)
9.1	362	Media types:**
1.1	363	*** application/xml (Page element)
9.1	364	Description:** Create or updates a page translation.
	365	Status codes:**
1.1	366	*** 201: If the page was created.
	367	*** 202: If the page was updated.
	368	*** 304: If the page was not modified.
	369	*** 401: If the user is not authorized.
9.1	370
	371	\\
	372
	373	* HTTP Method: DELETE
	374	Media types:**
1.1	375	*** application/xml (Page element)
9.1	376	Description:** Delete the page translation.
	377	Status codes:**
1.1	378	*** 204: If the request was successful.
	379	*** 401: If the user is not authorized.
	380
14.2	381	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/translations/{language}/history ===
9.1	382
	383	* HTTP Method: GET
	384	Media types:**
1.1	385	*** application/xml (History element)
9.1	386	Description:** The list of all the available revisions of the page in a given {language}.
	387	Status codes:**
1.1	388	*** 200: If the request was successful.
	389	*** 401: If the user is not authorized.
	390
14.2	391	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/translations/{lang}/history/{version} ===
9.1	392
	393	* HTTP Method: GET
	394	Media types:**
1.1	395	*** application/xml (Page element)
9.1	396	Description:** A page at a given {version} in a given {language}.
	397	Status codes:**
1.1	398	*** 200: If the request was successful.
	399	*** 401: If the user is not authorized.
	400
14.2	401	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/children ===
9.1	402
	403	* HTTP Method: GET
	404	Media types:**
1.1	405	*** application/xml (Pages element)
9.1	406	Description:** The list of the children of a given page.
	407	Status codes:**
1.1	408	*** 200: If the request was successful.
	409	*** 401: If the user is not authorized.
	410
14.2	411	== Tag resources ==
1.1	412
14.2	413	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/tags ===
9.1	414
	415	* HTTP Method: GET
	416	Media types:**
1.1	417	*** application/xml (Tags element)
9.1	418	Description:** List page tags.
	419	Status codes:**
1.1	420	*** 200: If the request was successful.
	421	*** 401: If the user is not authorized.
9.1	422
	423	\\
	424
	425	* HTTP Method: PUT
	426	Accepted Media types:**
1.1	427	*** application/xml (Tag element)
	428	*** text/plain
	429	*** application/x-www-form-urlencoded (allowed field names: tag)
9.1	430	Media types:**
1.1	431	*** application/xml (Tags element)
9.1	432	Description:** Add a tag to the page.
	433	Status codes:**
1.1	434	*** 202: If the request was successful.
	435	*** 401: If the user is not authorized.
	436
14.2	437	=== /wikis/{wikiName}/tags ===
9.1	438
	439	* HTTP Method: GET
	440	Media types:**
1.1	441	*** application/xml (Tags element)
9.1	442	Description:** The list of all available tags
	443	Status codes:**
1.1	444	*** 200: If the request was successful.
	445	*** 401: If the user is not authorized.
	446
14.2	447	=== /wikis/{wikiName}/tags/{tag1}[,{tag2},{tag3}...][?start~=offset&number~=n] ===
9.1	448
	449	* HTTP Method: GET
	450	Media types:**
1.1	451	*** application/xml (Pages element)
9.1	452	Description:** The list of pages having the specified tags.
	453	Status codes:**
1.1	454	*** 200: If the request was successful.
	455	*** 401: If the user is not authorized.
	456
14.2	457	== Comments resources ==
1.1	458
14.2	459	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/comments[?start~=offset&number~=n] ===
9.1	460
	461	* HTTP Method: GET
	462	Media types:**
1.1	463	*** application/xml (Comments element)
9.1	464	Description:** The list of comments on a given page.
	465	Status codes:**
1.1	466	*** 200: If the request was successful.
	467	*** 401: If the user is not authorized.
9.1	468
	469	\\
	470
	471	* HTTP Method: POST
	472	Accepted Media types:**
1.1	473	*** application/xml (Comment element)
	474	*** text/plain
20.1	475	*** application/x-www-form-urlencoded - allowed field names: ##text##, ##replyTo## (object number of the replied comment, since XE 2.3)
9.1	476	Media types:**
1.1	477	*** application/xml (Comment element)
9.1	478	Description:** Create a comment on the given page.
	479	Status codes:**
1.1	480	*** 201: If the comment was created. (The Location header will contain the URI where the comment has been created.)
	481	*** 401: If the user is not authorized.
	482
14.2	483	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/comments/{commentId} ===
9.1	484
	485	* HTTP Method: GET
	486	Media types:**
1.1	487	*** application/xml (Comment element)
9.1	488	Description:** A specific comment on a page
	489	Status codes:**
1.1	490	*** 200: If the request was successful.
	491	*** 401: If the user is not authorized.
	492
14.2	493	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/comments ===
9.1	494
	495	* HTTP Method: GET
	496	Media types:**
1.1	497	*** application/xml (Comments element)
9.1	498	Description:** The list of comments at a specific page {version}.
	499	Status codes:**
1.1	500	*** 200: If the request was successful.
	501	*** 401: If the user is not authorized.
	502
14.2	503	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/comments/{commentId} ===
9.1	504
	505	* HTTP Method: GET
	506	Media types:**
1.1	507	*** application/xml (Comment element)
9.1	508	Description:** A comment at a specific page {version}.
	509	Status codes:**
1.1	510	*** 200: If the request was successful.
	511	*** 401: If the user is not authorized.
	512
14.2	513	== Attachments resources ==
1.1	514
14.2	515	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/attachments[?start~=offset&number~=n] ===
9.1	516
	517	* HTTP Method: GET
	518	Media types:**
1.1	519	*** application/xml (Attachments element)
9.1	520	Description:** The list of attachments of a given page.
	521	Status codes:**
1.1	522	*** 200: If the request was successful.
	523	*** 401: If the user is not authorized.
	524
14.2	525	=== /wikis/{wikiName}/wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/attachments/{attachmentName} ===
9.1	526
	527	* HTTP Method: GET
	528	Media types:**
1.1	529	*** The same of the attachment media type.
9.1	530	Description:** The attachment identified by {attachmentName} on a given page.
	531	Status codes:**
1.1	532	*** 200: If the request was successful.
	533	*** 401: If the user is not authorized.
9.1	534
	535	\\
	536
	537	* HTTP Method: PUT
	538	Accepted media types:**
	539	* /**
	540	Media types:**
1.1	541	*** application/xml (AttachmentSummary element)
9.1	542	Description:** Create an attachment identified by {attachmentName} on a given page.
	543	Status codes:**
1.1	544	*** 201: If the attachment was created.
	545	*** 202: If the attachment was updated.
	546	*** 401: If the user is not authorized.
9.1	547
	548	\\
	549
	550	* HTTP Method: DELETE
	551	Media types:**
	552	Description:** Delete the attachment identified by {attachmentName} on a given page.
	553	Status codes:**
1.1	554	*** 204: If the attachment was deleted.
	555	*** 401: If the user is not authorized.
	556
14.2	557	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/attachments[?start~=offset&number~=n] ===
9.1	558
	559	* HTTP Method: GET
	560	Media types:**
1.1	561	*** application/xml (Attachments element)
9.1	562	Description:** The list of attachments at a given page {version}.
	563	Status codes:**
1.1	564	*** 200: If the request was successful.
	565	*** 401: If the user is not authorized.
	566
14.2	567	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/attachments/{attachmentName} ===
9.1	568
	569	* HTTP Method: GET
	570	Media types:**
1.1	571	*** The same of the attachment media type.
9.1	572	Description:** The attachment identified by {attachmentName} on a given page {version}.
	573	Status codes:**
1.1	574	*** 200: If the request was successful.
	575	*** 401: If the user is not authorized.
	576
14.2	577	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/attachments/{attachmentName}/history ===
9.1	578
	579	* HTTP Method: GET
	580	Media types:**
1.1	581	*** application/xml (??? element)
9.1	582	Description:** The list of available version for the {attachmentName}
	583	Status codes:**
1.1	584	*** 200: If the request was successful.
	585	*** 401: If the user is not authorized.
	586
14.2	587	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/attachments/{attachmentName}/history/{version} ===
9.1	588
	589	* HTTP Method: GET
	590	Media types:**
1.1	591	*** The same of the attachment media type.
9.1	592	Description:** The {attachmentName} at a given {version}
	593	Status codes:**
1.1	594	*** 200: If the request was successful.
	595	*** 401: If the user is not authorized.
	596
14.2	597	== Object resources ==
1.1	598
14.2	599	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects[?start~=offset&number~=n] ===
9.1	600
	601	* HTTP Method: GET
	602	Media types:**
1.1	603	*** application/xml (Objects element)
9.1	604	Description:** The list of objects associated to a page.
	605	Status codes:**
1.1	606	*** 200: If the request was successful.
	607	*** 401: If the user is not authorized.
9.1	608
	609	\\
	610
	611	* HTTP Method: POST
	612	Accepted media types:**
1.1	613	*** application/xml (Object element)
	614	*** application/x-www-formurlencoded (a set of property#name=value pairs representing properties and a field className)
9.1	615	Media types:**
	616	*** application/xml (Object element)
	617	Description:** Create a new object.
	618	Status codes:**
1.1	619	*** 201: If the object was created (The Location header will contain the URI associated to the newly created object).
	620	*** 401: If the user is not authorized.
	621
14.2	622	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects/{className}[?start~=offset&number~=n] ===
9.1	623
	624	* HTTP Method: GET
	625	Media types:**
1.1	626	*** application/xml (Objects element)
9.1	627	Description:** The list of objects of a given {className} associated to a page.
	628	Status codes:**
1.1	629	*** 200: If the request was successful.
	630	*** 401: If the user is not authorized.
	631
14.2	632	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects/{className}/{objectNumber} ===
9.1	633
	634	* HTTP Method: GET
	635	Media types:**
1.1	636	*** application/xml (Object element)
9.1	637	Description:** The object of type {className} identified by {objectNumber} associated to the given page.
	638	Status codes:**
1.1	639	*** 200: If the request was successful.
	640	*** 401: If the user is not authorized.
9.1	641
	642	\\
	643
	644	* HTTP Method: PUT
	645	Accepted media types:**
1.1	646	*** application/xml (Object element)
	647	*** application/x-www-formurlencoded (a set of property#name=value pairs representing properties)
9.1	648	Media types:**
	649	*** application/xml (Object element)
	650	Description:** Modify the object properties.
	651	Status codes:**
1.1	652	*** 202: If the object was updated.
	653	*** 401: If the user is not authorized.
9.1	654
	655	\\
	656
	657	* HTTP Method: DELETE
	658	Media types:**
	659	Description:** Delete the object.
	660	Status codes:**
1.1	661	*** 204: If the object was deleted.
	662	*** 401: If the user is not authorized.
	663
14.2	664	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects/{className}/{objectNumber}/properties ===
9.1	665
	666	* HTTP Method: GET
	667	Media types:**
1.1	668	*** application/xml (Properties element)
9.1	669	Description:** The properties of the object of type {className} identified by {objectNumber} associated to the given page.
	670	Status codes:**
1.1	671	*** 200: If the request was successful.
	672	*** 401: If the user is not authorized.
	673
14.2	674	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/objects/{className}/{objectNumber}/properties/{propertyName} ===
9.1	675
	676	* HTTP Method: GET
	677	Media types:**
1.1	678	*** application/xml (Properties element)
9.1	679	Description:** The property {propertyname} of the object of type {className} identified by {objectNumber} associated to the given page.
	680	Status codes:**
1.1	681	*** 200: If the request was successful.
	682	*** 401: If the user is not authorized.
9.1	683
	684	\\
	685
	686	* HTTP Method: PUT
	687	Accepted media types:**
1.1	688	*** application/xml (Property element)
	689	*** text/plain
	690	*** application/x-www-formurlencoded (a field property#name=value pairs representing a property)
9.1	691	Media types:**
	692	*** application/xml (Property element)
	693	Description:** Modify the object properties.
	694	Status codes:**
1.1	695	*** 202: If the object was updated.
	696	*** 401: If the user is not authorized.
	697
14.2	698	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/objects[?start~=offset&number~=n] ===
9.1	699
	700	* HTTP Method: GET
	701	Media types:**
1.1	702	*** application/xml (Objects element)
9.1	703	Description:** The list of objects associated to a page at a given {version}.
	704	Status codes:**
1.1	705	*** 200: If the request was successful.
	706	*** 401: If the user is not authorized.
	707
14.2	708	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/objects/{className}/{objectNumber} ===
9.1	709
	710	* HTTP Method: GET
	711	Media types:**
1.1	712	*** application/xml (Object element)
9.1	713	Description:** The object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
	714	Status codes:**
1.1	715	*** 200: If the request was successful.
	716	*** 401: If the user is not authorized.
	717
14.2	718	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties ===
9.1	719
	720	* HTTP Method: GET
	721	Media types:**
1.1	722	*** application/xml (Properties element)
9.1	723	Description:** The properties of the object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
	724	Status codes:**
1.1	725	*** 200: If the request was successful.
	726	*** 401: If the user is not authorized.
	727
14.2	728	=== /wikis/{wikiName}/spaces/{spaceName}/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties/{propertyName} ===
9.1	729
	730	* HTTP Method: GET
	731	Media types:**
1.1	732	*** application/xml (Properties element)
9.1	733	Description:** The property {propertyname} of the object of type {className} identified by {objectNumber} associated to the given page at a given {version}.
	734	Status codes:**
1.1	735	*** 200: If the request was successful.
	736	*** 401: If the user is not authorized.
	737
14.2	738	=== /wikis/{wikiName}/class/{className}/objects ===
9.1	739
	740	* HTTP Method: GET
	741	Media types:**
1.1	742	*** application/xml (Objects element)
9.1	743	Description:** The list of all the objects of a given {className}.
	744	Status codes:**
1.1	745	*** 200: If the request was successful.
	746	*** 401: If the user is not authorized.
	747
14.2	748	== Class resources ==
1.1	749
14.2	750	=== /wikis/{wikiName}/classes[?start~=offset&number~=n] ===
9.1	751
	752	* HTTP Method: GET
	753	Media types:**
1.1	754	*** application/xml (Classes element)
9.1	755	Description:** The list of all the classes defined in the wiki {wikiName}
	756	Status codes:**
1.1	757	*** 200: If the request was successful.
	758	*** 401: If the user is not authorized.
	759
14.2	760	=== /wikis/{wikiName}/classes/{className} ===
9.1	761
	762	* HTTP Method: GET
	763	Media types:**
1.1	764	*** application/xml (Class element)
9.1	765	Description:** The {className} definition
	766	Status codes:**
1.1	767	*** 200: If the request was successful.
	768	*** 401: If the user is not authorized.
	769
14.2	770	=== /wikis/{wikiName}/classes/{className}/properties ===
9.1	771
	772	* HTTP Method: GET
	773	Media types:**
1.1	774	*** application/xml (Properties element)
9.1	775	Description:** The properties of the class {className}.
	776	Status codes:**
1.1	777	*** 200: If the request was successful.
	778	*** 401: If the user is not authorized.
	779
14.2	780	=== /wikis/{wikiName}/classes/{className}/properties/{property} ===
9.1	781
	782	* HTTP Method: GET
	783	Media types:**
1.1	784	*** application/xml (Property element)
9.1	785	Description:** The property {property} of the class {className}.
	786	Status codes:**
1.1	787	*** 200: If the request was successful.
	788	*** 401: If the user is not authorized.
	789
14.2	790	== Other resources ==
1.1	791
14.2	792	=== /wikis/{wikiName}/modifications[?start~=offset&number~=n&timestamp~=t] ===
9.1	793
	794	* HTTP Method: GET
	795	Media types:**
1.1	796	*** application/xml (Modifications element)
9.1	797	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)
	798	Status codes:**
1.1	799	*** 200: If the request was successful.
	800	*** 401: If the user is not authorized.

Wiki source code of The XWiki RESTful API

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected