Utilisez les expressions OData supportées pour affiner votre requête et récupérer des données spécifiques depuis votre jeu de données.
Pour plus d'informations, consultez la documentation OData.
Expressivité OData supportée
Les modèles d'expressivité suivants peuvent être utilisés pour construire des requêtes spécifiques.
Remarque : Utiliser une option non supportée dans une requête OData résulte en une erreur
501 - Not Implemented
.url/$metadata
url/entity_set_name
url/entity_set_name(primary_key_value)
url/entity_set_name(primary_key_value)/column_name
url/entity_set_name(primary_key_value)/column_name/$value
url/entity_set_name?$top=n
url/entity_set_name?$skip=n
url/entity_set_name?$skip=n&$top=n
url/entity_set_name?$select=column_name
url/entity_set_name?$orderby=column_name asc|desc
url/entity_set_name?$filter=column_name eq 'value'
url/entity_set_name?$filter=contains(column_name, 'value')
Exemples de requêtes
Le tableau suivant présente quelques exemples de requêtes pouvant être envoyées à votre API. Dans cet exemple, une API a été créée pour le jeu d'entités nommécustomers
et le chemin de l'API générée est customers-api-2PZPTB
. Le jeu de données contient des colonnes nommées customer_age
, id
, customer_name
, customer_city
et customer_street
. La colonne id
est utilisé comme clé primaire.
Pattern (Modèle) | Description | Exemple |
---|---|---|
url/entity_set_name |
Obtenir toutes les données du jeu d'entités. |
Requête :
Réponse :
|
url/$metadata |
Obtenir les métadonnées du jeu d'entités. |
Requête :
Réponse :
|
url/entity_set_name(primary_key_value) |
Obtenir une entité spécifique via sa valeur de clé primaire. | Requête : Réponse :
|
url/entity_set_name(primary_key_value)/column_name |
Obtenir une colonne seule pour une entité spécifique. |
Requête :
Réponse :
|
url/entity_set_name(primary_key_value)/column_name/$value |
Obtenir la valeur brute d'une colonne pour une entité spécifique. |
Requête :
Réponse :
|
url/entity_set_name?$top=n |
Récupérer un nombre limité d'entités. |
Requête :
Réponse :
|
url/entity_set_name?$skip=n |
Récupérer une collection d'entités, en ignorant les n premières entités. |
Requête :
Réponse :
|
url/entity_set_name?$skip=n&$top=n |
Créer une pagination et obtenir une page spécifique d'entités à partir d'une collection. |
Requête :
Réponse :
|
url/entity_set_name?$select=column_name |
Récupérer seulement certains attributs d'entités. Remarque : La colonne utilisée comme clé primaire est toujours incluse.
|
Requête :
Réponse :
|
url/entity_set_name?$orderby=column_name asc|desc |
Récupérer une collection d'entités dans un ordre spécifique, à l'aide d'un ou plusieurs attribut·s. Les deux valeurs possibles pour cette option sont asc et desc . |
Requête :
Réponse :
|
url/entity_set_name?$filter=column_name eq 'value' |
Récupérer une collection d'entités correspondant à un filtre. |
Requête :
Réponse :
Remarque : Selon l'outil utilisé pour appeler l'API, il est possible d'obtenir une erreur si les espaces sont encodés avec des signes plus (
+ ). Pour éviter ce problème, assurez-vous que les espaces sont encodés en encodage-pourcent : %20 . |
url/entity_set_name?$filter=contains(column_name, 'value') |
Obtenez une collection d'entités correspondant à un filtre où column_name contient une certaine valeur ('value'). |
Requête :
Réponse :
|