project search facets
/members/{member}/projects/{group}/search/facets [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9400 |
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 are searched. The groups parameter can be used to narrow the groups selected. It must be a comma-separated list of group names.
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 | |
| searchgroups | If all then search all groups under the project (administrators only) | no | enum | user |
Permission
Only the member themselves with guest access to the project, 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 |