Web service API

How to use PageSeeder's Web service API

group omnibox

/groups/{group}/omnibox [GET]

com.pageseeder.search.AutoSuggest

Description

Service supporting the Omnibox in the PageSeeder user interface.

Warning!

This service is not part of the public API, and may be subject to change without notice!

This service is designed to return a list of result suggestions for the PageSeeder Omnibox and from a prefix match on a set of pre-configured fields.

The search is limited to a single group.

Auto-suggest configuration

The auto-suggestion function has been pre-configured to match terms in the following Index:

  • pstitle
  • psfilename
  • pscontent
  • psdocid
  • psid

To use the auto-suggest on a specific set of fields or for more information about the auto-suggest feature, see Service: /groups/{group}/autosuggest/fields [GET] (deprecated) instead.

Parameters

NameDescriptionRequiredTypeDefault value
termThe term to use in the omnibox ().yesstring
predicateAn additional Lucene predicate to narrow down the results.no lucene

Permission

Only members who have access to the group can invoke this service.

Response

Search results are wrapped in an <auto-suggest> element:

<auto-suggest term="[term]">
   <!-- Matching results listed here -->
   ... 
</auto-suggest>

Error Handling

No specific errors expected for this service.

Created on , last edited on