Options de requête système

L'API OData utilise les options de requête système pour contrôler la limite et l'ordre des données renvoyées pour une ressource. Les options de requête système peuvent être spécifiées dans les paramètres de chaîne de requête pour la ressource identifiée par l'URL. Le nom de toutes les options de requête système peut être précédé d'un caractère dollar ($). 
nfa1000
L'API OData de
DX NetOps Network Flow Analysis
utilise les options de requête système pour contrôler la limite et l'ordre des données renvoyées pour une ressource. Les options de requête système peuvent être spécifiées dans les paramètres de chaîne de requête pour la ressource identifiée par l'URL. Le nom de toutes les options de requête système peut être précédé d'un caractère dollar (
$
).
Les règles suivantes s'appliquent aux requêtes GET, PATCH et PUT :
  • Les chemins d'accès aux ressources indiquant une entité unique, une instance de type complexe, une collection d'entités ou une collection d'instances de type complexe prennent en charge
    $expand
    et
    $select
    .
  • Les chemins d'accès aux ressources indiquant une collection prennent en charge
    $filter
    ,
    $count, $orderby, $skip
    et
    $top
    .
  • Les chemins d'accès aux ressources finissant par
    /$count
    prennent en charge
    $filter
    .
  • Les chemins d'accès aux ressources ne finissant pas par
    /$count
    prennent en charge
    $format
    .
Dans le cas d'une URL avec requête POST, le type de retour détermine les options de requête système applicables qu'un service prend peut-être en charge. Les règles sont identiques à celles de la demande GET.
Les requêtes POST envoyées à un ensemble d'entités suivent les mêmes règles que les requêtes GET qui renvoient une entité unique.
N'appliquez pas l'option de requête système à une requête DELETE.
L'API OData de NFA rejette la requête si celle-ci contient des options de requête système non prises en charge.
Un service OData peut prendre en charge une partie ou la totalité des options de requête système définies. Si un service de données ne prend pas en charge une option de requête système, il doit rejeter toutes les requêtes contenant l'option non prise en charge.
Une même option de requête système ne doit pas être spécifiée plusieurs fois pour une ressource, même si elle est précédée du préfixe $.