/rest/api/search
Service to provide search logic (list and execute searches).
POST v1/count
Determines the result count of the search defined by the given QueryContainerDTO.
Response
application/json; charset=UTF-8
Integer -
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
FORM
queryContainer
The QueryContainerDTO to determine the result count.
false
GET v1/lucene
Returns the requested page from search result with the given id.
Response
application/json; charset=UTF-8
TextSearchResultDTO - DTO that contains the result of a text search (lucene).
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
PATH
searchId
The id of the initial search result..
false
QUERY
page
The requested page number.
false
POST v1/search
Executes the search defined by the given QueryContainerDTO.
Response
application/json; charset=UTF-8
AbstractDataContainerDTO - Container that holds the result entries of a search or workspace.
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
FORM
queryContainer
The QueryContainerDTO to execute.
false
POST v1/text-search
Performs a text search (via lucene) for the given query.
Response
application/json; charset=UTF-8
TextSearchResultDTO - DTO that contains the result of a text search (lucene).
Request
application/json; charset=UTF-8
Parameter Type
Type
Name
Description
Optional
Default Value
FORM
query
The search query.
false
Status Codes
Status Code
Description
608
Error during text search.