高級查詢 3.8
接口規范
- API 地址:
entity/adv-query
- HTTP 方法:POST
- 授權方式:通用授權
請求參數
參數 | 類型 | 是否必須 | 參數說明 |
---|---|---|---|
entity | string | 是 | 模塊內部名稱,如 Account ,可通過 元數據 接口獲取 |
fields | string | 是 | 要查詢的字段列表,多個字段以逗號(,)分隔 字段請通過 元數據 接口獲取 |
POST流 | json(map) | 是 | 查詢條件 filter |
sort | string | 否 | 排序,格式為 fieldName[:asc|desc] ,支持多個字段排序,多個字段以逗號(,)分隔。4.6 |
page_no | int | 否 | 頁碼,默認 1 |
page_size | int | 否 | 頁大小,默認 20,最大 200 |
filter 參數說明
首先來看一個典型的 filter 數據格式樣例
{ "type": "OR", "filters": [ { "fieldName":"phone", "operator":"cl", "value":"021" }, { "fieldName":"address", "operator":"cl", "value":"上海" } ] }
可以看出,這是一個標準的 JSON 格式數據,由兩個主要屬性節點構成,即 type
和 filters
。
type
取值范圍為OR | AND
,即標識以何種邏輯運算拼接filters
中的內容filters
具體的查詢條件(數組)
在 filters
節點內,可以包含多個查詢條件(最大支持10個),查詢條件屬性的具體含義如下。
fieldName
查詢字段operator
操作符,如大于、小于、包含等value
查詢值
operator 的可選值
值 | 說明 |
---|---|
= | 等于 |
<> | 不等于 |
> | 大于 |
< | 小于 |
cl | 包含 |
nc | 不包含 |
$NULL$ | 為空 |
$NOT_NULL$ | 不為空 |