表单API

导航

  1. 获取表单信息
  2. 获取表单列表
  3. 获取表单字段对照表
  4. 获取表单分组

获取表单信息

描述

根据表单id获取表单信息(表单名称、表单描述等)。

访问地址

http://api.jsform.com/api/v1/form/{formId}

访问方式

GET

参数

参数名数据类型是否必须示例值默认值描述
formIdString55b639212e8f3685227bf154表单ID

返回值

参数名描述
status执行状态。"success"表示成功,"error"表示失败
message如果失败,用此字段描述失败原因。如果成功,此字段为空。
form表单的详细信息

返回示例

{"status":"success","form":{"id":"55b639212e8f3685227bf154","form_desc":"表单描述", "update_time":1438453044305, "form_name":"表单名称", "create_by":"admin@jsform.com", "group_id":"55bc8d0c2e8f4d363ba991c9","group_name":"分组名称","create_time":1438005537663,"update_by":"admin@jsform.com"}}

表单列表字段说明

字段名描述
id表单ID
form_name表单名称
form_desc表单描述
group_id表单分组ID
group_name表单分组名称
create_by创建人
create_time创建时间
update_by最后修改人
update_time最后修改时间

curl示例

curl -u 51470abd078d49c496fda859:vWXVAWXeEQKfLlerFDMD3rsekBQzU5tz --header "Content-Type:application/json" --url http://api.jsform.com/api/v1/form/55b639212e8f3685227bf154

获取表单列表

描述

获取某账户下的所有表单。

访问地址

http://api.jsform.com/api/v1/formlist/{groupId}

访问方式

GET

参数

参数名数据类型是否必须示例值默认值描述
groupIdString55b639212e8f3685227bf154分组Id。可选择值为"all":获取所有表单列表;[groupId]:获取指定分组的表单列表;"nogroup":获取未分组的表单列表。

返回值

参数名描述
status执行状态。"success"表示成功,"error"表示失败
message如果失败,用此字段描述失败原因。如果成功,此字段为空。
rows所有表单列表

返回示例

{"status":"success","rows":[{"id":"55b639212e8f3685227bf154","form_desc":"表单描述", "update_time":1438453044305, "form_name":"表单名称", "create_by":"admin@jsform.com", "group_id":"55bc8d0c2e8f4d363ba991c9","group_name":"分组1", "create_time":1438005537663,"update_by":"admin@jsform.com"}]}

表单列表字段说明

字段名描述
id表单ID
form_name表单名称
form_desc表单描述
group_id表单分组ID
group_name表单分组名称
create_by创建人
create_time创建时间
update_by最后修改人
update_time最后修改时间

curl示例

curl -u 51470abd078d49c496fda859:vWXVAWXeEQKfLlerFDMD3rsekBQzU5tz --header "Content-Type:application/json" --url http://api.jsform.com/api/v1/formlist/55b639212e8f3685227bf154

获取表单字段对照表

描述

获取某个表单的字段名称与数据表中的字段对应关系。

访问地址

http://api.jsform.com/api/v1/fields/{formId}

访问方式

GET

参数

返回值

参数名描述
status执行状态。"success"表示成功,"error"表示失败
message如果失败,用此字段描述失败原因。如果成功,此字段为空。
fields所有字段的名称与字段名的对应关系

返回示例

{"status":"success","fields":{"field1":{data_type:"String","label":"单行文本"},"field2":{data_type:"Number","label":"数字"}}}

表单列表字段说明

见每个表单的API字段说明

curl示例

curl -u 51470abd078d49c496fda859:eWfALrToAuQvo47zDYFfaRxTVaeNsEIL --header "Content-Type:application/json" --url http://api.jsform.com/api/v1/fields/558e7b63926e2436667227fb

获取表单分组

描述

获取表单分组信息。

访问地址

http://api.jsform.com/api/v1/form/grouplist

访问方式

GET

参数

返回值

参数名描述
status执行状态。"success"表示成功,"error"表示失败
message如果失败,用此字段描述失败原因。如果成功,此字段为空。
groups所有表单的分组

返回示例

{"status":"success","groups":[{"id":"55ae4e9d2e8f1176ff21453f","name":"分组1"},{"id":"55ae4ea62e8f1176ff214540","name":"分组2"}]}

curl示例

curl -u 51470abd078d49c496fda859:eWfALrToAuQvo47zDYFfaRxTVaeNsEIL --header "Content-Type:application/json" --url http://api.jsform.com/api/v1/form/grouplist