查詢多筆資料 API - Jodoo

簡介

API簡介

透過查詢多筆資料 API，可以一次查詢表單中的多筆資料。

API調用

該 API 的返回資料，始終按照資料 ID 正序排列。

請求地址：https://api.jodoo.com/api/v5/app/entry/data/list

請求頻率：30 次/秒

請求方式：POST

請求參數：

參數	類型	必需	說明
app_id	String	是	應用 ID
entry_id	String	是	表單 ID
data_id	String	否	上一次查詢資料結果的最後一筆資料的 ID，沒有則留空
fields	Array	否	需要查詢的資料欄位
filter	JSON	否	資料篩選器
limit	Number	否	查詢的資料筆數，1~100，預設 10

資料篩選器

查詢多筆資料 API 同時也支援過濾，可透過 filter 參數進行資料過濾。

篩選結構：

參數	必需	類型	說明
rel	是	String	篩選組合關係；“and”(滿足所有過濾條件), “or”(滿足任一過濾條件)
cond	是	[JSON]	過濾條件列表

篩選範例：

{
    "rel": "and", // 或者 "or"
    "cond": [
        // 過濾條件
    ]
}

過濾條件結構：

參數	必需	類型	說明
field	是	String	欄位名
type	否	String	欄位類型
method	是	String	過濾方法： “not_empty”(不為空)， “empty”(為空)， “eq”(等於)， “in”(等於任意一個)，最多可傳遞 200 個 “range”(在x與y之間，並且包含x和y本身)， “nin”(不等於任意一個)，最多可傳遞 200 個 “ne”(不等於), “like”(文字包含) “verified“(表示填寫了手機號且已驗證的值) “unverified“(表示填寫了手機號但未驗證值)
value	否	Array	過濾值

過濾條件範例：

// 沒有參數的過濾條件
{
    "field": "_widget_1508400000001",
    "type": "text",
    "method": "empty"
}
// 有參數的過濾條件
{
    "field": "flowState",
    "type": "flowstate",
    "method": "eq",
    "value": [1]
}

目前支援如下欄位：

欄位類型	支援的過濾方式	說明
flowState	eq，ne	流程狀態，僅對流程表單有效
日期時間	eq，ne，range，empty，not_empty	/
數字	eq，ne，range，empty，not_empty	/
文字	eq，ne，in，nin，empty，not_empty	包括單行文字、下拉單選、單選、流水號
其他表單欄位（子表單欄位除外）	empty，not_empty	/

請求範例：

{
    "app_id": "59264073a2a60c0c08e20bfb",
     "entry_id": "59264073a2a60c0c08e20bfd",
   "data_id": "59e9a2fe283ffa7c11b1ddbf",
    "limit": 100,
    "fields": ["_widget_1508400000001", "_widget_1508400000002", "_widget_1508400000003"],
    "filter": {
        "rel": "and", // 或者 "or"
        "cond": [
            {
                "field": "_widget_1508400000001",
                "type": "text",
                "method": "empty"
            },
            {
                "field": "_widget_1508400000002",
                "type": "number",
                "method": "not_empty"
            },
            {
                "field": "flowState",
                "type": "flowstate",
                "method": "eq",
                "value": [0]
            },
             {
                "field":"CreateTime",
                "method":"range",
                "value":["2022-01-01",null]
            }
        ]
    }
}

回應參數：

參數	類型	說明
data	Array	多筆資料的集合

回應資料樣例：

{
    "data": [{
            "_id": "59e9a2fe283ffa7c11b1ddbe",
            "appId": "59264073a2a60c0c08e20bfb",
            "entryId": "59264073a2a60c0c08e20bfd",
            "creator": {
                "name": "Jodoo",
                "username": "Jodoo",
                "status": 1,
                "type": 0,
                "departments": [1, 3],            
            },
            "createTime": "2017-10-20T22:41:51.430Z",
            "updateTime": "2017-10-20T11:12:15.293Z",
            "_widget_1432728651402": "A班",
            "_widget_1615777739673": [{
                    "_id": "604ed0298e2ade077c7245f1",
                    "_widget_1615777739744": "子表單資料1"
                },
                {
                    "_id": "604ed0298e2ade077c7245f2",
                    "_widget_1615777739744": "子表單資料2"
                }
            ]
        },
        {
            "_id": "59e9a2fe283ffa7c11b1ddbf",
            "appId": "59264073a2a60c0c08e20bfb",
            "entryId": "59264073a2a60c0c08e20bfd",
            "creator": {
                "name": "Jodoo",
                "username": "Jodoo",
                "status": 1,
                "type": 0,
                "departments": [1, 3],
            },
            "createTime": "2017-10-20T22:41:51.430Z",
            "updateTime": "2017-10-20T11:12:15.293Z",
            "_widget_1432728651402": "B班",
            "_widget_1615777739673": [{
                    "_id": "604ed0298e2ade077c7245f3",
                    "_widget_1615777739744": "子表單資料1"
                },
                {
                    "_id": "604ed0298e2ade077c7245f4",
                    "_widget_1615777739744": "子表單資料2"
                }
            ]
        }
    ]
}

查詢多筆資料 API調試

簡介

API簡介

API調用

資料篩選器