Web service API

How to use PageSeeder's Web service API

project search facets

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

com.pageseeder.search.GetFacets

Description

Get search facets for multiple groups.

This service does the same as the group search but the search is not performed and only the facets for the search are returned.

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

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.

Parameters

NameDescriptionRequiredTypeDefault value
facetsA comma-separated list of fields to use as facets.nostrings
facetsizeThe max number of facet values to load (max 1000).nointeger10
filtersA comma-separated list of field:term pairs to use as filters.nostrings
flexiblefacetsA comma-separated list of fields to use as flexible facets.nostrings
groupsA comma-separated list of group names (only used when there is a project on the request).nostrings
questionThe question to search for.nostring
questionfieldsA comma-separated list of fields to search the question in.nostringspstitle,pscontent
rangesA comma-separated list of range searches.nostrings
searchgroupsIf 'all' then search all groups under the project (administrators only).noenumuser

Permission

Permissions requirements to be updated.

Response

The XML response is:

<facets>
  ...
</facets>

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

Error Handling

0x1501 If there is an invalid group specified
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