Web service API

How to use PageSeeder's Web service API

project search predicate

/members/{member}/projects/{group}/search/predicate [GET]

com.pageseeder.search.Search

Description

Search multiple groups by predicate.

The indexes

The current implementation of PageSeeder produces one Lucene index per group. All the groups under the project on the request that the member has access to will be searched. The groups parameter can be used to narrow the groups selected. It must be a comma-separated list of group names.

Note

Only groups that use the same template as the project will be searched because they use the same index catalog.

The query

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
groupsA comma-separated list of group names (only used when there is a project on the request).nostrings
pageThe current page to view.nointeger1
pagesizeHow many results does a page contain.nointeger100
predicateThe lucene predicate, takes precedence over the question parameter.nostring
searchgroupsIf 'all' then search all groups under the project (administrators only).noenumuser
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

CodeCause / Description
0x1501If there is an invalid group specified
0x1502If there are no indexes selected
0x1503If the predicate is not valid
0x1504If a sort field cannot be used for sorting
0x1505If the facet size specified is bigger than the global property for face size ( maxFacetSize)
0x1506If a numeric field is specified as a facet

Created on , last edited on