SearchApi

All URIs are relative to http://localhost

Method	HTTP request	Description
arrangedSearch	POST /search-api/v1/search/arranged/{tenant}
getDocument	GET /search-api/v1/doc/{tenant}/{id}
getTenants	GET /search-api/v1/tenants
search	GET /search-api/v1/search/{tenant}	Search for documents

arrangedSearch

SearchResult arrangedSearch(tenant, ArrangedSearchQuery)

Parameters

Name	Type	Description	Notes
tenant	String	tenant name	[default to null]
ArrangedSearchQuery	ArrangedSearchQuery	A list of all search requests that should be part of a single response

Return type

SearchResult

Authorization

basic-auth

HTTP request headers

• Content-Type: Not defined
• Accept: /

getDocument

Document getDocument(tenant, id)

Parameters

Name	Type	Description	Notes
tenant	String	tenant name	[default to null]
id	String	document id	[default to null]

Return type

Document

Authorization

basic-auth

HTTP request headers

• Content-Type: Not defined
• Accept: /

getTenants

getTenants()

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basic-auth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

search

SearchResult search(tenant, searchQuery, filters)

Search for documents

Runs a search request for a certain tenant. The tenant should exist at the service and linked to a certain index in the backend. Different tenants may use the same index.

Parameters

Name	Type	Description	Notes
tenant	String	tenant name	[default to null]
searchQuery	SearchQuery	the query that describes the wished result	[default to null]
filters	Map	Any other parameter is considered as filter. Each one is validated according to the actual data and configuration. Each filter can have multiple values, separated by comma. Commas inside the values have to be double-URL encoded. Depending on the configured filter type these values are used differently (see examples).	[optional] [default to null]

Return type

SearchResult

Authorization

basic-auth

HTTP request headers

• Content-Type: Not defined
• Accept: /, text/plain