Syntax: POST /rest/v1/search
Dieser Aufruf führt eine Suche über den externen Suchdienst aus.
Sollte der Suchindex mehrdeutig sein, werden Ergebnisse für jeden Suchindizen ausgegeben. Diese Reinfolge ist nicht eindeutig vorherbestimmt, die inhalte der Suche aber schon. Wenn ein Suchindex mittels ID ermittelt wird, sind die Suchergebnisse immer eindeutig. Das Suchverhalten ist undefiniert wenn mehr als 10000 Dokumente auf den Suchbegriff passen.
Um zu meiden, dass sich das Verhalten der Schnittstelle durch das Erstellen/Anpassen von Suchindex-Konfigurationen oder Übersetzungen ändert, ist es am sinnvollsten, den Index über seine ID zu hinterlegen.
Parameter (Body)
| Name | Pflicht | Beschreibung |
|---|---|---|
| index | Ja | Oid von Suchindex, Oid von Übersetzung, Name von Suchindex, ORM Typ inkl. Vererbung |
| term | Ja | Suchbegriff nach welchem gesucht werden soll |
| fields | Nein | Welche Felder sollen übertragen werden? |
| skip | Nein | Überspringe die ersten X Suchergebnisse. |
| take | Nein | Zeige die nächsten X Suchergebnisse. |
Mögliche Rückgabestatus
| Status | Beschreibung |
|---|---|
| 200 OK | Der externe Suchdienst hat die Anfrage erfolgreich bearbeitet. |
| 403 Forbidden | Der aktuelle Benutzer hat nicht die Berechtigung die Suche anzustoßen. |
| 500 Internal server error | Bei der Verarbeitung kam es zu einem unvorhergesehenen Fehler. |
Rückgabe
Der Aufruf dieses Endpunkts liefert eine JSON-Struktur mit Informationen über die Suchergebnisse für alle Suchindicies aus.
Beispiel:
[
{
"Index": "4e3be329-3d7e-49c1-bbbb-c5adba79cf16",
"Title": "Offers and Proalpha offers",
"TotalCount": 0,
"ReturnCount": 0,
"Documents": []
},
{
"Index": "af8ddd29-10fb-45fa-a751-9133a46d956c",
"Title": "Addresses",
"TotalCount": 4,
"ReturnCount": 3,
"Documents": [
{
"Id": "5432735d-b7c0-45f8-a988-002c948ba476"
},
{
"Id": "f83cada0-bbc7-406a-ba52-7b8dd48d2570"
},
{
"Id": "1437550c-3377-4e79-bffa-8e579d691546"
}
]
},
{
"Index": "e80e0b6d-7f8e-4c9c-9b7f-cbc15c1fa810",
"Title": "Company profile",
"TotalCount": 2,
"ReturnCount": 2,
"Documents": [
{
"Id": "5c454d1f-176b-4074-a949-24d1fb815f97"
},
{
"Id": "fa748d9d-cc58-4e0b-9d26-8626659d21ec"
}
]
}
]