表單 API - Jodoo - 開放平臺

簡介

API 簡介

開發前，請仔細閱讀開發指南。

以下所有 API 路徑中的 app_id 和 entry_id 分別表示應用 ID 和該應用內的表單 ID，因此 app_id+entry_id 表示全局唯一的表單 ID。

API 調用

表單欄位查詢 API

取得指定表單的欄位/欄位資訊，除分割線欄位和查詢欄位以外。具體可以查閱文件最後的欄位與資料類型對照表。

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

請求頻率：30 次/秒

請求參數：

參數	類型	必需	說明
app_id	String	是	應用 ID
entry_id	String	是	表單 ID

{
    "app_id": "59264073a2a60c0c08e20bfb",
    "entry_id": "59264073a2a60c0c08e20bfd"
}

回應內容：

只要每一個表單欄位不刪除，欄位 ID 就不會變化：

參數	含義
widgets	欄位資訊
widgets[].label	欄位標題
widgets[].name	欄位名（設定了欄位別名則採用別名，未設定則採用欄位ID）
widgets[].type	欄位類型；每種欄位類型都有對應的資料類型
widgets[].items	僅子表單控件有；陣列裏包含了每個子欄位的資訊
sysWidgets	系統欄位列表（連結參數、流程欄位受功能開關影響）
sysWidgets[].name	系統欄位名稱
dataModifyTime	表單內資料最新修改時間（可用於判斷表單內的資料是否發生變更）

回應範例：

{
    "widgets": [
        {
            "name": "_widget_1529400746031",
            "label": "單行文字",
            "type": "text"
        },
        {
            "name": "_widget_1529400746045",
            "label": "多行文字",
            "type": "textarea"
        },
        {
            "name": "_widget_1529400746056",
            "label": "數字",
            "type": "number"
        },
        {
            "name": "_widget_1529400746068",
            "label": "日期",
            "type": "datetime"
        },
        {
            "name": "_widget_1529400746079",
            "label": "日期時間",
            "type": "datetime"
        },
        {
            "name": "_widget_1529400746090",
            "label": "單選",
            "type": "radiogroup"
        },
        {
            "name": "_widget_1529400746105",
            "label": "複選",
            "type": "checkboxgroup"
        },
        {
            "name": "_widget_1529400746119",
            "label": "下拉單選",
            "type": "combo"
        },
        {
            "name": "_widget_1529400746136",
            "label": "下拉複選框",
            "type": "combocheck"
        },
        {
            "name": "_widget_1529400746191",
            "label": "圖片",
            "type": "image"
        },
        {
            "name": "_widget_1529400746209",
            "label": "附件",
            "type": "upload"
        },
        {
            "name": "_widget_1529400746221",
            "label": "子表單",
            "type": "subform",
            "items": [
                // 同主表
            ]
        },
        {
            "name": "_widget_1529400746242",
            "label": "關聯資料",
            "type": "linkdata"
        },
        {
            "name": "_widget_1529400746254",
            "label": "手寫簽名",
            "type": "signature"
        },
        {
            "name": "_widget_1529400746696",
            "label": "成員單選",
            "type": "user"
        },
        {
            "name": "_widget_1529400746713",
            "label": "成員多選",
            "type": "usergroup"
        },
        {
            "name": "_widget_1529400746729",
            "label": "部門單選",
            "type": "dept"
        },
        {
            "name": "_widget_1529400746746",
            "label": "部門多選",
            "type": "deptgroup"
        }
    ],
    "sysWidgets": [
        {
            "name": "flowState"
        },
        {
            "name": "wx_open_id"
        },
        {
            "name": "wx_nickname"
        },
        {
            "name": "wx_gender"
        },
        {
            "name": "creator"
        },
        {
            "name": "updater"
        },
        {
            "name": "deleter"
        },
        {
            "name": "ext"
        },
        {
            "name": "createTime"
        },
        {
            "name": "updateTime"
        },
        {
            "name": "deleteTime"
        }
    ],
    "dataModifyTime": "2021-09-08T03:40:26.586Z"
}