Last modified by Thomas Mortagne on 2017/03/24

<
From version < 19.1 >
edited by Vincent Massol
on 2012/10/21
To version < 20.1 >
edited by Fabio Mancinelli
on 2012/10/22
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.fmancinelli
Content
... ... @@ -54,6 +54,26 @@
54 54  
55 55  {{image reference="DistributionWizard-stepDone.png"/}}
56 56  
57 +== REST API improvements ==
58 +
59 +Some improvements have been done to the REST API in order to allow more powerful searches of the data stored in the wiki.
60 +
61 +* Results can be ordered using the ##/wikis/{wikiName}/search## and ##/wikis/{wikiName}/spaces/{spaceName}/search## resources with the following parameters:
62 +** //orderField//: one of the XWiki document field, as specified in http://platform.xwiki.org/xwiki/bin/view/DevGuide/velocityHqlExamples#HXWikiDocument
63 +** //order//: ##asc## or ##desc##". By default ##asc## is used.
64 +
65 +* Advanced search queries can be specified using ##/wikis/{wikiName}/query## resources with the following parameters:
66 +** //q//: the query to be executed (it depends on the query type)
67 +** //type//: ##hql##, ##xwql## or ##lucene##. Depending on the query type, the //q// parameter will contain a query matching the type
68 +*** For ##hql## it's like a searchDocuments query, as shown in specified in http://platform.xwiki.org/xwiki/bin/view/DevGuide/velocityHqlExamples.
69 +*** For ##xwql## the user is allowed to use XWQL syntax for short queries (http://dev.xwiki.org/xwiki/bin/view/Design/XWiki+Query+Language+Specification )
70 +*** For ##lucene## it's a standard Lucene query handled by the Lucene plugin (http://extensions.xwiki.org/xwiki/bin/view/Extension/Lucene+Plugin )
71 +** Standard parameters like //start//, //number// can be specified to control the number of the results to be returned.
72 +
73 +* Multi-wiki Lucene search using the ##/wikis/query## resource with the following parameters:
74 +** //q//: the Lucene query handled by the Lucene plugin (http://extensions.xwiki.org/xwiki/bin/view/Extension/Lucene+Plugin )
75 +** //wikis//: a comma separated list of wikis where to perform the search.
76 +
57 57  == Miscellaneous ==
58 58  
59 59  * XWiki's multiwiki feature (a.k.a "virtual mode") now works with the HSQLDB database

Get Connected