group omnibox
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.7006 | 5.9800 | xml, json |
Description
Service supporting the search box in the PageSeeder user interface.
This service is not part of the public API, and might be subject to change without notice!
This service is designed to return a list of result suggestions for the PageSeeder seach box 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:
pstitlepsfilenamepscontentpsdocidpsid
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] (obsolete) instead.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| term | The term to use in the search box () | yes | string | |
| predicate | An additional Lucene predicate to narrow down the results | no | lucene |
Permission
This service is restricted to guest and higher unless the group is accessible to public.
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.