Global Search API

These are the endpoints for the global search frontend.

Method Endpoint

Method	Endpoint
`GET`	`/cxf/bpc-globalsearch/search/{instanceId}/search`
Description Performs a search over multiple indices and modules.
Path Parameter `instanceId` the id of the related global search instance
Query Parameter `query` the query to perform the search for `start` first record to be read (optional, default = 0). Default is `0`. `limit` number of records to read (optional, default = 100, max. 10.000). Default is `100`. `indices` to limit the search only to those specific indices (separate multiple values with a comma) `modules` to search only in the OpenSearch indices of these modules (separate multiple values with a comma) `adminSearch` flag to perform a search on the bpc-configuration index. Get used only for users with the 'bpcadmin' role (optional, default = false). Default is `false`.
Returns The response for the global search. HTTP Status Code `200` : OK Content-Type `application/json`
Required Access Rights A logged in user or API Key is required.

/cxf/bpc-globalsearch/search/{instanceId}/search

Description

Performs a search over multiple indices and modules.

Path Parameter

Query Parameter

query: the query to perform the search for
start: first record to be read (optional, default = 0). Default is 0.
limit: number of records to read (optional, default = 100, max. 10.000). Default is 100.
indices: to limit the search only to those specific indices (separate multiple values with a comma)
modules: to search only in the OpenSearch indices of these modules (separate multiple values with a comma)
adminSearch: flag to perform a search on the bpc-configuration index. Get used only for users with the 'bpcadmin' role (optional, default = false). Default is false.

Returns

The response for the global search.

HTTP Status Code

Content-Type

Required Access Rights

A logged in user or API Key is required.