- Home
- Resources
- FullTextSearch
REST interface for the social networking library (post and its comments).
GET /2/full-text-search/search-by-query
Retrieve posts/comments that match the given query
Request Parameters
| name |
type |
description |
default |
constraints |
| Authorization |
header |
Bearer token, see https://dev.d4science.org/how-to-access-resources |
|
|
| Content-Type |
header |
application/json |
|
|
| from |
query |
the index of the base result to be returned, range[0, infinity], defaults from = 0 |
0 |
min: 0 |
| quantity |
query |
defines how many results are most are to be returned, range[1, infinity], defaults from = 0, |
10 |
min: 0 |
| query |
query |
A string to search for |
|
required, max size: 2147483647, min size: 1 |
Response Codes
| code |
condition |
| 200 |
Successful retrieval of posts/comments that match the query, reported in the 'result' field of the returned object |
| 500 |
The error is reported into the 'message' field of the returned object |
Response Body
| media type |
data type |
description |
| application/json |
object
(JSON) |
The posts/comments returned belong to the context bound to the AUTH Token |
Example
Request
GET /2/full-text-search/search-by-query
Content-Type: */*
Accept: application/json
Authorization: ...
...
Response
HTTP/1.1 200 OK
Content-Type: application/json
...