API 請求主體中的過濾器
篩選提供基本條件查詢和頁面控制,用於處理 API 請求。 過濾有三個基本組件:條件、排序和分頁參數。
瞭解過濾器
基本過濾器用戶過濾器可搜索單個條件,也可以用邏輯操作數 和 和 或包裝。使用者篩選,以簡單地條件化評估單一欄位。過濾器中使用的值,例如運算符和字段特定於它們所使用的 API 。
默認值顯示在尖括號 中。每個參數只能使用一個值。
單參數篩選器
頁面
{
"filter": {
"operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
"field": "string",
"value": "string"
}
}
兩個參數篩選器{
"filter": {
"operator": "<and, or>",
"operands": [
{
"operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
"field": "string",
"value": "string"
},
{
"operator": "<NONE, lt, le, eq, ne, ge, gt, substring, and, or, not>",
"field": "string",
"value": "string"
}
]
}
}
操作 | 描述 | 範例 |
---|---|---|
lt | 小於 | 數量 lt 1500 |
LE | 小於或等於 | 數量 le 1500 |
EQ | 等於 | UserEmailAddress 、 eq first.last@aa.com |
Ne | 不等於 | 用戶電子郵件地址, ne first.last@aa.com |
GE | 大於或等於 | CreatedDateUtc GE 2021-03-15 |
gt | 大於 | CreatedDateUtc gt 2021-03-15 |
and | 和 | Field1 eq 'abc' 和 Field2 eq 'def' |
or | 或 | Field1 eq 'abc' 或 Field2 eq 'def' |
"page":{
"offset":0,
"length":0
}
分頁
規則參數
- 偏移量:
類型:整數
指示如何操作的數值 篩選器開始評估的表格中有許多列。
- 長度
類型:整數
在單個中返回的行數 結果頁面。
"sort": [
{
"field": "string",
"direction": "<asc, desc>"
}
- 字段:您要篩選結果的欄位。這必須是支持的可過濾字段。可過濾字段因 API 而異。
- 方向
類型:enum [ desc , asc ]
- ASC = 升序(最小到最大, 0 到 9 , A 到 Z )
- Desc = 降序(最大到最小, 9 到 0 , Z 到 A )
API 篩選器範例
- 用戶管理過濾器示例
此示例過濾器基於用戶管理 API 字段和參數。 此過濾器搜索用戶登錄名、 用戶名和用戶 名。
- 存儲庫管理過濾器示例
此示例過濾器基於系統信息庫管理 API 字段和參數。 此過濾器示例搜索 bot 狀態和名稱。
- 遷移列表結果過濾器示例
此示例過濾器基於遷移 API 字段和參數。 此過濾器搜索 名稱中包含特定字段 且在 兩個日期之間啓動更新的遷移。