Reihenfolge der Suchergebnisse per API anpassen

Ab der Cloud Version 44, haben Administratoren die Möglichkeit die Reihenfolge der Suchergebnisse per API Zugriff zu verändern. Konkret kann die Reihenfolge der verschiedenen Typen von Suchergebnissen in der  Suchergebnis Seite angepasst werden.

 

Bildschirmfoto_2022-07-22_um_11.45.12.png

Was sind die Voraussetzungen und API-Einstellungen?

  1. Es ist eine "Bearer-Authentifizierung" mit gültigem "oAuth-Token" erforderlich.
  2. Um die Sucherfahrung anzupassen wird die globale Berechtigung "MANAGE_GLOBAL_SEARCH" benötigt.

Verfügbare Optionen

Sind sämtliche Voraussetzungen erfüllt, gibt es verschiedene Optionen in die Sortierung der Suchergebnisse einzugreifen bzw. deren Reihenfolge zu verändern.

 

Tipp:

Suchergebnis-Typen, die bei angepasster Sortierung nicht explizit in den Einstellungen definiert werden, werden am Ende der Suchergebnisse in alphabetischer Reihenfolge dargestellt.

 

Get Settings

Es werden alle Einstellungen der globalen Suche abgerufen.

Befehl:

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

Beispielhafte Antwort:

 

Bildschirmfoto_2022-07-22_um_14.58.14.png

 

Get single Setting

Es werden die Daten einer einzelnen Einstellung abgerufen.

Befehl: 

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

Beispielhafter Befehl:

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

Beispielhafte Antwort:

 

Bildschirmfoto_2022-07-22_um_13.37.14.png

 

Set single setting

Es wird eine einzelne Einstellung definiert. Mit "readonly: true" gekennzeichnete Einstellungen, können nicht geändert werden.

Befehl:

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

Beispielhafter Befehl:

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

Beispielhafte Antwort:

 

Bildschirmfoto_2022-07-22_um_13.41.56.png

 

Delete single setting

Es wird eine einzelne Einstellung gelöscht. Mit "readonly: true" gekennzeichnete Einstellungen, können nicht geändert werden.

Befehl:

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

Beispielhafter Befehl:

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

Beispielhafte Antwort:

 

Bildschirmfoto_2022-07-22_um_13.45.54.png

War dieser Beitrag hilfreich?