Web service API

How to use PageSeeder's Web service API

group search predicate

/groups/{group}/search/predicate [GET]

com.pageseeder.search.Search

Description

Search a single group by predicate.

The parameters used for a predicate query are predicate and defaultfield. The predicate specified must be parseable by the Lucene classic parser. See http://lucene.apache.org/core/5_2_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html  for more info.

For details see Service: /groups/{group}/search [GET].

Warning!

The predicate specification may change with different Lucene versions so this service should not be used for production systems.

Parameters

NameDescriptionRequiredTypeDefault value
defaultfieldThe default field, only used with the predicate parameter.nostringpscontent
facetsA comma-separated list of fields to use as facets.nostrings
facetsizeThe max number of facet values to load (max 1000).nointeger10
fieldsizeMaximum number of characters allowed in a result field (max 10000).nointeger1000
pageThe current page to view.nointeger1
pagesizeHow many results does a page contain.nointeger100
predicateThe Lucene predicate, takes precedence over the question parameter.nostring
sortfieldsA comma-separated list of fields to sort the results.nostrings

Permission

Permissions requirements to be updated.

Response

The XML response is:

<search>
    <query> ... </query>
    <facets> ... </facets>
    <results> ... </results>
</search>

For details see Service: /groups/{group}/search [GET].

Error Handling

0x1501 If there is an invalid group specified
0x1502 If there are no indexes selected
0x1503 If the predicate is not valid
0x1504 If a sort field cannot be used for sorting
0x1505 If the facet size specified is bigger than the global property for face size ( maxFacetSize)
0x1506 If a numeric field is specified as a facet

Created on , last edited on