常见的 OData 查询参数

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