Wiki source code of The XWiki RESTful API

Version 39.1 by Fabio Mancinelli on 2012/11/07

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

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