Wiki source code of The XWiki RESTful API

Version 17.2 by Vincent Massol on 2009/12/17

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