Rôle des paramètres OData
$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 :
OData et l’API / 5. 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
OData et l’API / 2. Opérateurs OData compatibles
OData et l’API / 3. Fonctions OData compatibles
$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 : OData et l’API / 4. OData pagination avec l’API