project search predicate
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9400 |
Description
Search multiple groups by predicate.
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.
The query
The parameters used for a predicate query are predicate and defaultfield. The predicate specified must be parseable by the Lucene classic parser. See http://lucene.apache.org/core/5_2_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html for more info.
For details see Service: /groups/{group}/search [GET].
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| defaultfield | The default field, only used with the predicate parameter | no | string | pscontent |
| 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 |
| fieldsize | Maximum number of characters allowed in a result field (max 10000) | no | integer | 1000 |
| groups | A comma-separated list of group names (only used when there is a project on the request) | no | strings | |
| page | The current page to view | no | integer | 1 |
| pagesize | How many results does a page contain | no | integer | 100 |
| predicate | The lucene predicate, takes precedence over the question parameter | no | string | |
| searchgroups | If all then search all groups under the project (administrators only) | no | enum | user |
| sortfields | A comma-separated list of fields to sort the results | no | strings |
Permission
Only the member themselves with guest access to the project, or an administrator, can invoke this service.
Response
The XML response is:
<search> <query> ... </query> <facets> ... </facets> <results> ... </results> </search>
For details see Service: /groups/{group}/search [GET].
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1501 | If there is an invalid group specified |
| 0x1502 | If there are no indexes selected |
| 0x1503 | If the predicate is not valid |
| 0x1504 | If a sort field cannot be used for sorting |
| 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 |