常见的 OData 查询参数

ASoC API 中最常见的 OData 参数包括:
$top
用于限制系统返回的记录数。只需向其传递一个整数,API 就会采用 $top 的值,并最多返回根据 $orderby 参数确定的记录数。例如,要返回前五个扫描:https://cloud.appscan.com/api/v4/Scans?$top=5
$filter
定义返回的记录。如果为此参数提供一个表达式,则系统将针对该表达式对每条记录进行求值计算。将返回对表达式求值为 true 的所有记录。此过滤器参数非常强大且有用。例如,要返回所有具有高风险分级的应用程序:https://cloud.appscan.com/api/v4/Apps?$filter=RiskRating+eq+'High'
$select
定义结果中包含的字段。当您仅对特定字段感兴趣而不想包含其他任何内容时,这很有用。例如,所有应用程序的名称和创建日期,但不含其他信息:https://cloud.appscan.com/api/v4/Apps?$select=Name,DateCreated
$skip
定义要跳过的记录数。例如,要列出除前两个策略以外的所有策略:https://cloud.appscan.com/api/v4/Policies?$skip=2
$orderby
定义结果集的顺序。为此参数提供一个字段,系统将按字段顺序组织返回的结果集。就像 SQL 查询一样,顺序可以为降序或升序,方法是将 descasc 追加到参数。字符串字段按字母顺序排序;数字字段按数字顺序排序。例如,要返回所有扫描的列表,首先按创建日期降序排序:https://cloud.appscan.com/api/v4/Scans?$orderby=CreatedAt+desc
$expand

指定要与检索到的资源一起包括的相关资源。它还可用于从相关资源展开所选属性。例如,要仅包含创建扫描的用户的标识和用户名:https://cloud.appscan.com/api/v4/Scans?$expand=CreatedBy($select=Id,UserName)

$apply
已使用查询选项 $apply 触发聚合行为。它采用一系列集转换,用正斜杠分隔,以表示它们是连续应用的,例如,每次转换的结果是下一次转换的输入。这与在路径段中使用服务定义的可绑定和可组合函数一致。例如,要根据 RiskRating 对存在问题的应用程序进行分组,并返回每个 RiskRating 的应用程序数:https://cloud.appscan.com/api/v4/Scans?$apply=filter(TotalIssues+gt+0)/groupby((RiskRating),aggregate($count+as+N))