API filtrage, pagination & tri

Filtrage sur les champs standard

Chaque ressource de collection d'entité racine contient certains paramètres de filtre spécifiques. Si vous avez des besoins de filtrage supplémentaires qui pourraient améliorer les performances
de votre utilisation de l'API, faites-le nous savoir à support@robaws.be et nous évaluerons votre demande.

Filtrage sur les champs supplémentaires

Le filtrage sur les champs supplémentaires est possible en utilisant la syntaxe d'URL suivante.
Attention, les caractères [ et ] doivent être encodés en URL !

Champs Texte, Lien, Choix multiple
GET /api/v2/articles?extraFields[YourFieldName]=TextValue
Champ Booléen
GET /api/v2/articles?extraFields[YourFieldName]=true
GET /api/v2/articles?extraFields[YourFieldName]=false
Champs Nombre entier et décimal
GET /api/v2/articles?extraFields[YourFieldName]=90
GET /api/v2/articles?extraFields[YourFieldName]=3.67
Champs Date
GET /api/v2/articles?extraFields[YourFieldName]=2021-07-08

Inclure les ressources liées

Les endpoints GET de notre API vous fournissent un paramètre de requête 'include' optionnel. Cela vous permet d'inclure les associations imbriquées nécessaires dans la réponse sans devoir effectuer plusieurs requêtes GET. Exemple ; GET /api/v2/employees?include=employer,employer.contacts,certificates. Si vous ne spécifiez pas le paramètre include, nous renvoyons toujours la valeur id pour les associations many/one-to-one.

Pagination

Chaque ressource de collection d'entité racine est paginable. Deux syntaxes équivalentes sont prises en charge : offset et limit, ou page et size (si les deux sont fournies, offset/limit prévaut). Attention, la taille maximale de page est de 100. La taille de page par défaut est de 10.
Pour obtenir des résultats de tri prévisibles, nous ajoutons un tri par défaut (id:asc) si aucun n'est fourni. La réponse de pagination contient des informations sur le nombre de pages disponibles compte tenu de la page et de la taille fournies. Exemple d'utilisation :

GET /api/v2/employees?page=0&size=10 //première page
GET /api/v2/employees?page=1&size=10 //deuxième page

Tri

Chaque ressource de collection d'entité racine peut être triée à l'aide du paramètre de requête 'sort'. Exemple d'utilisation :

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

Mis à jour le : 05/07/2026