Paramètres de requête OData communs

Les paramètres OData les plus communs rencontrés dans l'API ASoC 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://cloud.appscan.com/api/v4/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://cloud.appscan.com/api/v4/Apps?$filter=RiskRating+eq+'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://cloud.appscan.com/api/v4/Apps?$select=Name,DateCreated
$skip
Définit le nombre d'enregistrements à ignorer. Par exemple, pour répertorier toutes les stratégies, excepté les deux premières : https://cloud.appscan.com/api/v4/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. Par exemple, pour renvoyer une liste de tous les examens, triés par date de création dans l'ordre décroissant : https://cloud.appscan.com/api/v4/Scans?$orderby=CreatedAt+desc
$expand

Spécifie les ressources associées à inclure en ligne avec les ressources récupérées. Il peut également être utilisé pour développer les propriétés sélectionnées à partir des ressources associées. Par exemple, pour inclure uniquement l'ID et le nom d'utilisateur de l'utilisateur qui a créé l'examen : https://cloud.appscan.com/api/v4/Scans?$expand=CreatedBy($select=Id,UserName)

$apply
Le comportement d'agrégation est déclenché à l'aide de l'option de requête $apply. Il prend une séquence de transformations définies, séparées par des barres obliques pour indiquer qu'elles sont appliquées consécutivement. Par exemple, le résultat de chaque transformation est l'entrée de la transformation suivante. Cela est cohérent avec l'utilisation de fonctions de liaison et composables définies par le service dans les segments de chemin. Par exemple, pour regrouper les applications présentant des problèmes selon leur évaluation des risques et renvoyer le nombre d'applications par évaluation des risques : https://cloud.appscan.com/api/v4/Scans?$apply=filter(TotalIssues+gt+0)/groupby((RiskRating),aggregate($count+as+N))