Search API
Fetching Search Results
Request
| HTTP Method | GET |
| Endpoint | /api/v1/documents |
By sending a request to Fess like http://<Server Name>/api/v1/documents?q=search_term, you can receive Fess search results in JSON format. To use the search API, you need to enable JSON responses in the Administration screen under System > General Settings.
Request Parameters
You can perform more advanced searches by specifying request parameters such as http://<Server Name>/api/v1/documents?q=search_term&num=50&fields.label=fess. The available request parameters are as follows:
| q | Search term. Pass it after URL encoding. |
| start | Starting position of the result count. Starts from 0. |
| num | Number of items to display. Default is 20 items. Can display up to 100 items. |
| sort | Sort order. Used to sort search results. |
| fields.label | Label value. Used to specify a label. |
| facet.field | Facet field specification. (Example) facet.field=label |
| facet.query | Facet query specification. (Example) facet.query=timestamp:[now/d-1d TO *] |
| facet.size | Specification of the maximum number of facets to retrieve. Valid when facet.field is specified. |
| facet.minDocCount | Retrieve facets with a count equal to or greater than this value. Valid when facet.field is specified. |
| geo.location.point | Latitude and longitude specification. (Example) geo.location.point=35.0,139.0 |
| geo.location.distance | Distance from the center point specification. (Example) geo.location.distance=10km |
| lang | Search language specification. (Example) lang=en |
| preference | String to specify the shard during search. (Example) preference=abc |
| callback | Callback name when using JSONP. Not necessary to specify if not using JSONP. |
Table: Request Parameters
Response
The following response is returned:
(Formatted)
{
"q": "Fess",
"query_id": "bd60f9579a494dfd8c03db7c8aa905b0",
"exec_time": 0.21,
"query_time": 0,
"page_size": 20,
"page_number": 1,
"record_count": 31625,
"page_count": 1,
"highlight_params": "&hq=n2sm&hq=Fess",
"next_page": true,
"prev_page": false,
"start_record_number": 1,
"end_record_number": 20,
"page_numbers": [
"1",
"2",
"3",
"4",
"5"
],
"partial": false,
"search_query": "(Fess OR n2sm)",
"requested_time": 1507822131845,
"related_query": [
"aaa"
],
"related_contents": [],
"data": [
{
"filetype": "html",
"title": "Open Source Enterprise Search Server: Fess — Fess 11.0 documentation",
"content_title": "Open Source Enterprise Search Server: Fess — Fe...",
"digest": "Docs » Open Source Enterprise Search Server: Fess Commercial Support Open Source Enterprise Search Server: Fess What is Fess? Fess is a powerful and easily deployable Enterprise Search Server. ...",
"host": "fess.codelibs.org",
"last_modified": "2017-10-09T22:28:56.000Z",
"content_length": "29624",
"timestamp": "2017-10-09T22:28:56.000Z",
"url_link": "https://fess.codelibs.org/",
"created": "2017-10-10T15.30:48.609Z",
"site_path": "fess.codelibs.org/",
"doc_id": "e79fbfdfb09d4bffb58ec230c68f6f7e",
"url": "https://fess.codelibs.org/",
"content_description": "Enterprise Search Server: Fess Commercial Support Open...Search Server: Fess What is Fess? Fess is a very powerful...You can quickly install and run Fess on any platform...Fess is provided under the Apache license...Apache license. Demo Fess is an OpenSearch-based search",
"site": "fess.codelibs.org/",
"boost": "10.0",
"mimetype": "text/html"
}
]
}
Each element is as follows:
Searching All Documents
To search all target documents, send the following request: http://<Server Name>/api/v1/documents/all?q=search_term
To use this feature, you need to set api.search.scroll to true in fess_config.properties.
Request Parameters
The available request parameters are as follows:
| q | Search term. Pass it after URL encoding. |
| num | Number of items to display. Default is 20 items. Can display up to 100 items. |
| sort | Sort order. Used to sort search results. |
Table: Request Parameters
Error Response
When the search API fails, the following error response is returned:
| Status Code | Description |
| 400 Bad Request | When request parameters are invalid |
| 500 Internal Server Error | When an internal server error occurs |
Error response example:
{
"message": "Invalid request parameter",
"status": 400
}