project search
/members/{member}/projects/{group}/search [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9400 |
Description
Search multiple groups by question.
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 every group under the project that the member can access. To narrow the target groups, use the groups parameter with 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 | |
| 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 |
| 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 |
| sortfields | A comma-separated list of fields to sort the results | no | strings | |
| suggestsize | The max number of suggestions to load (only for question query) | no | integer | 20 |
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> <suggestions> ... </suggestions> <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 |