Starting with Cloud version 44, administrators have the ability to change the order of search results via API access. Specifically, the order of the different types of search results can be customized in the search results page.

Requirements

1. "Bearer authentication" with a valid "oAuth token" is required.
2. To customize the search experience, the global permission "MANAGE_GLOBAL_SEARCH" is required.

Available options

Once all prerequisites are met, several options exist to intervene in sorting the search results or to change their order.

Tip:

Search result types that are not explicitly defined in the settings when sorting is customized are displayed at the end of the search results in alphabetical order.

Get Settings

All settings of the global search are retrieved.

Command:

"GET: /web/global-search/settings"

Sample response:

Get single Setting

The data of a single setting will be retrieved.

Command:

"GET: /web/global-search/settings/{name-of-setting}"

Example command:

"GET: /web/global-search/settings/typeOrder"

Sample response:

Set single setting

A single setting is defined. Settings marked with "readonly: true", cannot be changed.

Command:

"POST: /web/global-search/settings/{name-of-setting}"
"Body: {"value": ...}"

Example command:

"POST: /web/global-search/settings/typeOrder"
"Body: {"value": ["page", "workspace", "user"]"

Sample response:

Delete single setting

A single setting will be deleted. Settings marked with "readonly: true", cannot be changed.

Command:

Example command:

Sample response: