Search API

Mit den Search APIs ist es möglich, in den Daten von Customa zu suchen. Jede API-Entität hat seinen eigenen API-Endpunkt für die Suche. Dabei können Suchkriterien anhand von Filtern definiert werden.

Filter

Da die Filter ein umfangreicheres Thema sind, werden diese daher auf einer eigenen Seite behandelt.

Pagination

Die Pagination erfolgt anhand der übergebenen Parameter. Wenn die Seitengröße zu groß ist, gibt Customa eine geringere Seitengröße als die erwünschte zurück. Clients haben dementsprechend den von Customa zurückgegebenen Wert als oberste Grenze für die mögliche Seitengröße bei den folgenden Anfragen zu berücksichtigen.

Sortierung

In der Rückgabe der Search API sind die Einträge immer nach ID aufsteigend sortiert. Diese Sortierung lässt sich aktuell nicht ändern.