- Home
- Resources
- SearchResource
Resource for endpoints that are forwarded to elasticsearch for performing searches
POST /elastic/{path}
Perform a search by forwarding the posted search request to elasticsearch under the given path.
The path will be prefixed with the index name.
Request Parameters
name |
type |
description |
default |
constraints |
multivalued |
path |
path |
path (e.g. /_search) |
|
regex: .* |
no |
contenttags |
query |
true to add content tags to pages |
false |
boolean |
no |
folder |
query |
true to add the folder to search hits |
false |
boolean |
no |
folderId |
query |
optional folderId to restrict search to specific folder(s) |
|
int |
yes |
langvars |
query |
true to add language variants to pages |
false |
boolean |
no |
nodeId |
query |
optional nodeId to restrict search to a specific node |
0 |
int |
no |
objecttags |
query |
true to add object tags to search hits |
false |
boolean |
no |
privilegeMap |
query |
true to add privilege maps to folders |
false |
boolean |
no |
privileges |
query |
true to add privilege information to folders |
false |
boolean |
no |
recursive |
query |
flag for restricting search to given folderIds and their subfolders |
false |
boolean |
no |
template |
query |
true to add the template to pages |
false |
boolean |
no |
translationstatus |
query |
true to add the translation status to pages |
false |
boolean |
no |
Request Body
media type |
data type |
description |
application/json |
string
(JSON) |
request body |
Response Codes
code |
condition |
401 |
No valid sid and session secret cookie were provided. |
405 |
Feature elasticsearch is not activated. |
Response Body
media type |
data type |
description |
application/json |
object
(JSON) |
response |
Example
Request
POST /elastic/{path}
Content-Type: application/json
Accept: application/json
...
Response
HTTP/1.1 201 Created
Content-Type: application/json
...