OData : Paramètres de requêtes et rôle
Des paramètres de requête OData facultatifs permettent de contrôler la quantité de données renvoyées dans une réponse.
| Paramètre | Type | Description |
|---|---|---|
| $expand | string | Liste les relations à développer et à inclure dans la réponse |
| $filter | string | Filtre le résultat |
| $select | string | Liste les propriétés à inclure dans la réponse |
| $orderby | string | Tri le résultat |
| $top | integer | Nombre d’éléments à retourner dans la réponse |
| $skip | integer | Jeton de pagination pour obtenir l’ensemble des résultats suivants |
| $count | boolean | Nombre total d’éléments répondants à la requête |
$expand
Ce paramètre permet dans la même requête de récupérer les informations de la ressource principale mais aussi les informations d’une ou plusieurs sous ressources de la ressource principale.
Exemple : pour récupérer les données d’un client et de son compte principal au lieu d’utiliser deux requêtes :
{url API}/{datasetId}/clients('{id client}')
{url API}/{datasetId}/clients('{id client}')/comptePrincipal
on pourra utiliser une seule requête avec dans $expand la mention de la sous ressource comptePrincipal
{url API}/{datasetId}/clients('{id client}')?$expand=comptePrincipal
Attention ! $expand n’est autorisé que pour les sous ressources dont la cardinalité de la relation est 1..? ou 1..1.
Voir Cardinalité des relations dans Vue d’ensemble ressources API
Vous pouvez mentionner plusieurs sous ressources les unes à la suite des autres séparées par une virgule :
{url API}/{datasetId}/clients('{id client}')?$expand=comptePrincipal,devise,tiersPayeur
Voir aussi :
Concepts clés / OData - Propriétés de Navigation
Exemples / Exemples simples de requêtes métier
$filter - $select - $orderby
Ces paramètres vont respectivement servir à filtrer, limiter le contenu des données à récupérer et classer les données.
Voir des exemples et la syntaxe :
Exemples / Exemples simples de requêtes métier
Concepts clés / OData - opérateurs compatibles avec l’API
Concepts clés / OData - fonctions compatibles avec l’API
$top - $skip - $count
Ces paramètres vont surtout être utiles pour gérer la notion de pagination.
Cette notion de pagination est fondamentale.
Voir le détail ici : Concepts clés / OData - Pagination avec l’API