Form APIsAPI Explorer
Introduction
API Introduction
Form APIs include Form Field Query API
Before developing form APIs, you need to read the developer's guide carefully.
In the following API paths, app_id and entry_id refer to the app ID and the form ID in the app respectively. Therefore, app_id+entry_id refers to a unique form ID.
API Calling
Form Fields Query API
Call the field list or field information of a specified form, except Divider and RelatedQuery fields. For details, see Reference Table for Field & Data Type.
Request URL: https://api.jodoo.com/api/v5/app/entry/widget/list
Request Frequency: 30 times/second
Request Parameters:
Parameter | Type | Required | Description |
app_id | String | Yes | App ID |
entry_id | String | Yes | Form ID |
Sample Request:
{
"app_id": "59264073a2a60c0c08e20bfb",
"entry_id": "59264073a2a60c0c08e20bfd"
}Responses:
As long as each form field is not deleted, the field ID will not change:
Parameter | Description |
widgets | Field information |
widgets[].label | Field title |
widgets[].name | Field name (use the alias if a field alias is set; otherwise, use the field ID) |
widgets[].type | Field type; each field type has a corresponding data type. |
widgets[].items | Exclusive to Subform; the array contains information about each subfield. |
sysWidgets | List of system fields |
sysWidgets[].name | Name of system fields |
dataModifyTime | The latest updated time of the data in the form (can be used to determine whether the data in the form has changed). |
Sample Response:
{
"widgets": [
{
"name": "_widget_1529400746031",
"label": "Single Line",
"type": "text"
},
{
"name": "_widget_1529400746045",
"label": "Multi Line",
"type": "textarea"
},
{
"name": "_widget_1529400746056",
"label": "Number",
"type": "number"
},
{
"name": "_widget_1529400746068",
"label": "Date&Time",
"type": "datetime"
},
{
"name": "_widget_1529400746090",
"label": "Radio",
"type": "radiogroup"
},
{
"name": "_widget_1529400746105",
"label": "Checkbox",
"type": "checkboxgroup"
},
{
"name": "_widget_1529400746119",
"label": "Single Select",
"type": "combo"
},
{
"name": "_widget_1529400746136",
"label": "Multi Select",
"type": "combocheck"
},
{
"name": "_widget_1529400746191",
"label": "Image",
"type": "image"
},
{
"name": "_widget_1529400746209",
"label": "Attachment",
"type": "upload"
},
{
"name": "_widget_1529400746221",
"label": "Subform",
"type": "subform",
"items": [
// the same as the main form
]
},
{
"name": "_widget_1529400746242",
"label": "RelatedData",
"type": "linkdata"
},
{
"name": "_widget_1529400746254",
"label": "Signature",
"type": "signature"
},
{
"name": "_widget_1529400746696",
"label": "Member",
"type": "user"
},
{
"name": "_widget_1529400746713",
"label": "Members",
"type": "usergroup"
},
{
"name": "_widget_1529400746729",
"label": "Department",
"type": "dept"
},
{
"name": "_widget_1529400746746",
"label": "Departments",
"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"
}