Web service API

How to use PageSeeder's Web service API

autosuggest group fields

/groups/{group}/autosuggest/fields [GET]



Return result suggestions from a query for a specific field

This service returns the list of result suggestions from a prefix match on a set of fields.

Auto-suggest vs auto-complete

The auto-complete function simply returns the list of possible search terms using prefix matching.

For example, for term "ali", the auto-complete will return terms like "align", "alignment", etc.

The auto-suggest feature returns possible search results by using the auto-complete function on a list of terms and the executing the corresponding query with these terms.

For example, for term "ali", the auto-suggest will first determine the list of possible match terms and then will return the best matching search results including these terms.


NameDescriptionRequiredTypeDefault value
fieldsThe index fields to searchyesstring
termThe prefix of the  termsyesstring
predicateA additional predicate - this is an advanced optionnoLucene predicate+type:document


Although the fields and term parameters are not strictly required, that is an error will not be thrown is they are not specified, this service will only return search results if both parameters are specified. This behaviour may change in future releases.


Undocumented permissions requirements.


If both parameters fields and term are specified. This service returns the following XML:

<auto-suggest term="term">
  <search-results index="[id]">
    <query lucene="[lucene query]">
          <!-- List of possible matching terms -->
          <term field="[index field name]"
                text="[matching term]"/>
        <condition>[lucene predicate]</condition>
        <!-- each suggested results as a Lucene document -->
        <document> ... </document>

If it isn't used one of the parameters, the return is:

<auto-suggest term="doctest">
        <query lucene="+pstype:document +()">


Error Handling

No specific errors expected for this service.

Created on , last edited on