一般 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 查詢,順序可藉由將
desc
或asc
附加至參數,決定以遞減或遞增排序。字串欄位會按字母順序排序;數值欄位則是按數字順序排序。例如,如要傳回所有掃描的清單,請依據建立日期遞減順序排序:https://cloud.appscan.com/api/v4/Scans?$orderby=CreatedAt+desc
- $expand
-
指定要包含在所擷取資源中的相關資源。也可用該方式擴展相關資源中選取的內容。例如,僅包含建立掃描之使用者的 ID 和使用者名稱:
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))