Artikel über: Schnittstellen

API-Filterung, Paginierung und Sortierung

Filterung nach Standardfeldern


Jede Root-Entitätensammlung (root entity collection ressource) enthält spezifische Filterparameter.


Wenn Sie zusätzliche Filteranforderungen haben, die die Leistung Ihrer API-Nutzung verbessern könnten, lassen Sie es uns bitte unter support@robaws.be wissen. Wir werden Ihre Anfrage prüfen.




Filterung nach Zusatzfeldern


Die Filterung nach Zusatzfeldern ist mithilfe der folgenden URL-Syntax möglich.


Beachten Sie, dass die Zeichen [ und ] in der URL kodiert sein müssen!



Text, Link, Auswahlfelder


GET /api/v2/articles?extraFields[IhrFeldname]=TextValue



Boolean-Felder


GET /api/v2/articles?extraFields[IhrFeldname]=true


GET /api/v2/articles?extraFields[IhrFeldname]=false



Ganzzahl- und Dezimalfelder


GET /api/v2/articles?extraFields[IhrFeldname]=90


GET /api/v2/articles?extraFields[IhrFeldname]=3.67



Datumsfelder


GET /api/v2/articles?extraFields[IhrFeldname]=2024-10-31




Einbinden verwandter Ressourcen


Die GET-Endpoint in unserer API bieten einen optionalen 'include'-Query Parameter *(Abfrageparameter)***.


Damit können Sie die benötigten verschachtelten Verknüpfungen in die Antwort aufnehmen, ohne mehrere GET-Anfragen ausführen zu müssen.


Wenn Sie den 'include'-Parameter nicht angeben, geben wir standardmäßig nur die ID-Werte für viele/eins-zu-eins-Verknüpfungen zurück.



Beispiel


GET /api/v2/employees?include=employer,employer.contacts,certificates




Paginierung


Jede Root-Entitätensammlung ist mit den Query Parametern offset und limit paginiert. Beachten Sie, dass die maximale Seitengröße 100 beträgt. Die Standard-Seitengröße beträgt 10.


Um vorhersehbare Sortierergebnisse zu erhalten, fügen wir eine Standardsortierung hinzu, wenn keine angegeben ist.


Die Paginierungsantwort enthält Informationen darüber, wie viele Seiten es bei den angegebenen Seiten- und Größenwerten gibt.



Beispiel


GET /api/v2/employees?page=0&size=10 //erste Seite


GET /api/v2/employees?page=1&size=10 //zweite Seite




Sortierung


Jede Root-Entitätensammlung ist mit dem Queryparameter 'sort' sortierbar.



Beispiel


GET /api/v2/employees?sort=surname:asc,name:desc

Aktualisiert am: 21/10/2024

War dieser Beitrag hilfreich?

Teilen Sie Ihr Feedback mit

Stornieren

Danke!