<
From version < 41.1 >
edited by Thomas Mortagne
on 2014/11/21
To version < 43.1 >
edited by Guillaume Delhumeau
on 2015/07/09
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ThomasMortagne
1 +XWiki.gdelhumeau
Content
... ... @@ -255,7 +255,9 @@
255 255  * **HTTP Method:** GET
256 256  ** **Media types:**
257 257  *** application/xml (SearchResults element)
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.
258 +** **Description:** Search resources (pages and attachments):
259 +*** [since 6.4] using a SOLR query (handled by the [[SOLR Query module>>extensions:Extension.Solr Search Query API]]) on the wikis that are specified as a comma separated list in the //wikis// parameter. If //className// is specified, the result will also contain the data for the first object of the corresponding class.
260 +*** [before 6.4] using a Lucene query (handled by the [[Lucene Plugin>>extensions:Extension.Lucene Plugin]]) on the wikis that are specified as a comma separated list in the //wikis// parameter. If //className// is specified, the result will also contain the data for the first object of the corresponding class.
259 259  ** **Status codes:**
260 260  *** 200: If the request was successful.
261 261  
... ... @@ -294,7 +294,7 @@
294 294  * **HTTP Method:** GET
295 295  ** **Media types:**
296 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.
299 +** **Description:** Allow to execute HQL, XWQL, Lucene or SOLR queries on the given {wikiName}. The //q// parameter contains the corresponding query. See [[HQL Query Examples in Velocity>>platform:DevGuide.velocityHqlExamples]], [[XWiki Query Language Specification>>dev:Design.XWiki Query Language Specification]], [[Lucene Plugin>>extensions:Extension.Lucene Plugin]] and [[SOLR query API>>extensions:Extension.Solr Search Query API]] examples of the queries that can be specified in this parameter. If //className// is specified, the result will also contain the data for the first object of the corresponding class.
298 298  ** **Status codes:**
299 299  *** 200: If the request was successful.
300 300  
... ... @@ -937,6 +937,21 @@
937 937  
938 938  The xwiki-platform-rest-api module can be also seen as an authoritative reference for the REST API.
939 939  
942 += Generate a REST URL for a resource =
943 +
944 +If you need to generate a REST URL for a resource inside a script, you can use the REST script services:
945 +
946 +{{code language="velocity"}}
947 +$services.rest.url($entityReference)
948 +{{/code}}
949 +
950 +Where ##$entityReference## could be:
951 +
952 +* a ##DocumentReference##
953 +* a ##SpaceReference##
954 +
955 +We plan to add more supported entities in the future (ObjectReference, ClassReference, etc...).
956 +
940 940  = Using the RESTful API =
941 941  
942 942  == Highlevel description and tutorial for a basic usage of the RESTful API ==

Get Connected