Paramètres de requête OData communs

Les paramètres OData les plus communs rencontrés dans l'API AppScan 360° sont :

$top

Utilisé pour limiter le nombre d'enregistrements renvoyés par le système. Transmettez-lui simplement un entier et l'API prendra la valeur de $top et renverra au maximum ce nombre d'enregistrements, comme déterminé par le paramètre $orderby. Par exemple, pour renvoyer les cinq premiers examens : https://<domaine>/api/v2/Scans?$top=5

$filter

Définit quels enregistrements sont renvoyés. Si vous fournissez une expression à ce paramètre, chaque enregistrement sera évalué selon cette expression. Tous les enregistrements évalués comme "True" pour l'expression sont renvoyés. Ce paramètre de filtre est très puissant et utile. Par exemple, pour renvoyer toutes les applications évaluées comme présentant un risque élevé : https://<domaine>/api/V2/Apps?$filter=RiskRating%20eq%20'High'

$select

Définit quels champs sont inclus dans les résultats. Cela s'avère utile lorsque vous n'êtes intéressé que par certains champs et ne souhaitez pas inclure autre chose. Par exemple, pour obtenir les noms et dates de création de toutes les applications, mais aucune autre information : https://<domaine>/api/V2/Apps?$select=Name%2CDateCreated

$skip

Définit le nombre d'enregistrements à ignorer. Par exemple, pour répertorier toutes les stratégies, excepté les deux premières : https://<domaine>/api/V2/Policies?$skip=2

$orderby

Définit l'ordre de l'ensemble des résultats. Vous fournissez un champ à ce paramètre et l'ensemble des résultats renvoyé sera trié selon l'ordre du champ. L'ordre peut être décroissant ou croissant, comme pour une requête SQL, en ajoutant desc ou asc au paramètre. Les champs de chaîne sont triés par ordre alphabétique ; les champs numériques sont triés par ordre numérique. Il semble que vous ne pouvez fournir qu'une seule valeur à ce paramètre (bien que l'exemple en ait deux). Par exemple, pour renvoyer une liste de tous les examens, triés premièrement par date de création, puis par nom : https://<domaine>/api/v2/Scans?$orderby=CreatedAt%20desc