Skip to main content

 Services

Web services from /about to /webhooks

server search facets

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

com.pageseeder.search.GetFacets

Description

Get search facets for all member’s groups

This service does the same as the group search but collates the results from multiple groups.

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

The indexes

The current implementation of PageSeeder produces one Lucene index per group.

This service searches all the member’s groups. To narrow the target groups, use the groups parameter with a comma-separated list of group names.

The service returns an error if any of the following fields are in the parameters because they could be defined differently in different project catalogs: psproperty-*, psmetadata-*, psinline-, psblock-.

Parameters

NameDescriptionRequiredTypeDefault
facetsA comma-separated list of fields to use as facetsnostrings
facetsizeThe max number of facet values to load (max 1000)nointeger10
filtersA comma-separated list of field:term pairs to use as filtersnostrings
flexiblefacetsA comma-separated list of fields to use as flexible facetsnostrings
groupsA comma-separated list of group names (only used when there is a project on the request)nostrings
questionThe question to search fornostring
questionfieldsA comma-separated list of fields to search the question innostringspstitle,pscontent
rangesA comma-separated list of range searchesnostrings

Permission

Only the member themselves, or an administrator, can invoke this service.

Response

The XML response is:

<facets indexes="[comma separated group IDs]" [warning=""]>
  ...
</facets>

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

Error Handling

CodeCause / Description
0x1501If there is an invalid group specified
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