server search facets
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9800 |
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
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| facets | A comma-separated list of fields to use as facets | no | strings | |
| facetsize | The max number of facet values to load (max 1000) | no | integer | 10 |
| filters | A comma-separated list of field:term pairs to use as filters | no | strings | |
| flexiblefacets | A comma-separated list of fields to use as flexible facets | no | strings | |
| groups | A comma-separated list of group names (only used when there is a project on the request) | no | strings | |
| question | The question to search for | no | string | |
| questionfields | A comma-separated list of fields to search the question in | no | strings | pstitle,pscontent |
| ranges | A comma-separated list of range searches | no | strings |
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
| Code | Cause / Description |
|---|---|
| 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 |