宜点云宜点课堂
  • 首页
  • 帮助文档
  • 后端python
  • 开放平台
  • 私有云
  • 场景案例
  • 更新日志
返回控制台
返回控制台
  • 产品简介
  • 套餐、配置、私有云
    • 收费模式
    • 私有云
    • 公有云平台性能解释
    • 私有云配置性能介绍
    • 充值与套餐的购买、升级、续费
  • 第三方集成
    • 钉钉集成
      • 钉钉集成管理
      • 钉钉通讯录的同步与修改
      • 消息推送-钉钉
      • 在钉钉终端使用
      • 解除钉钉应用授权
    • 企业微信集成
      • 企业微信集成管理
      • 通讯录的同步
      • 企业微信激活
      • 企业微信接口调用许可说明
      • 企业微信账号购买
    • 飞书集成
      • 飞书集成管理
      • 飞书通讯录同步及修改
      • 消息推送-飞书
      • 在飞书终端使用
      • 解除飞书应用授权
    • 微信服务号集成
      • 微信服务号集成流程
      • 配置说明
      • 消息通知
      • 解绑&关闭
      • 微信消息模板变更说明
  • 快速入门
    • 账号注册和登录
    • 快速使用
      • 应用安装及基本设置
      • 权限分配和应用分享
        • 成员邀请和通讯录管理
        • 共享和权限分配
        • 系统管理员和普通管理员
      • 数据管理
        • 数据操作
    • 快速开发
      • 制作一个表单
      • 对内分享和对外分享
      • 数据管理
      • 制作报表
    • 移动端帮助手册
      • 移动端使用
      • 个人中心
      • 工作台
      • 应用访问
      • 流程管理
      • 微信小程序上访问
      • 移动端一期改版说明
      • 移动端二期改版说明
      • 移动端三期流程中心改版说明
    • 镜像访问模式
    • 电脑端表单改版说明
  • 工作台
    • 自定义工作台
    • 待办任务
    • 应用管理
      • 流程待办
      • 应用分组
      • 应用排序
      • 创建新应用
      • 快捷操作
      • 应用分享
      • 导出安装包
      • 应用内表单管理
    • 账户中心
      • 个人设置
      • 安全中心
    • 企业管理
      • 企业设置
      • 会员购买
      • 版本信息
      • 财务
      • 安全策略
      • 登录日志
      • 企业日志
      • 使用统计
      • 自定义登录页
    • 消息中心
      • 消息类型
      • 通知设置
      • 消息接收人管理
    • 导出管理
    • 退出账号
  • 团队和通讯录
    • 普通模式
      • 成员管理
        • 成员邀请
        • 已删除成员管理
        • 成员停用与启用
      • 部门管理
      • 管理员
      • 角色
      • 交接工作
      • 职位替代部门主管
      • 职位说明
      • 成员关系说明
    • 企业微信模式
      • 企业微信通讯录的同步
    • 钉钉模式
      • 钉钉通讯录同步与修改
    • 飞书模式
      • 飞书通讯录同步与修改
    • 外部联系人
      • 外部联系人管理
      • 外部联系人使用
      • 分组管理
      • 小程序设置
      • 第三方团队外部联系人
    • 互联组织
      • 外部企业
        • 公开链接邀请互联企业
        • 批量导入邀请互联企业
        • 互联企业导入失败问题汇总
        • 代管企业
      • 其他设置
        • 我方对接人
        • 我方对接部门
        • 邀请我协作的企业
      • 外部对接人&外部角色
      • 互联组织使用
        • 工作台添加外部应用
        • 互联组织权限
        • 互联组织表单使用
        • 互联组织报表使用
        • 互联组织流程协作
        • 互联组织打印模板使用
        • 互联组织消息提醒
    • 通讯录同步到表单
  • 表单设计
    • 表单类型与创建
      • 创建空白表单
      • 从Excel创建表单
      • 表单类型介绍
    • 表单控件
      • 控件基础说明
      • 描述信息详解
      • 基础控件
        • 单行文本
        • 多行文本
        • 数字
        • 日期时间
        • 单选按钮组
        • 复选框组
        • 下拉框
        • 下拉复选框
        • 扩展按钮
          • 扩展按钮-后端事件
          • 扩展按钮-功能插件
          • 扩展按钮-数据助手
          • 扩展按钮-弹出报表
          • 扩展按钮-弹出表单
          • 扩展按钮-页面打印
          • 扩展按钮-弹出外部网页
          • 扩展按钮-前端事件
        • 分割线
      • 增强控件
        • 地址
        • 定位
        • 图片
        • 附件
        • 子表单
          • 子表单字段属性
          • 子表单补充说明
          • 子表单数据加载
          • 子字段显隐规则
          • 子表单操作权限
        • 关联查询
        • 关联数据
        • 数据加载
        • 流水号
        • 手写签名
      • 部门成员控件
        • 成员控件
        • 部门控件
      • 控件回收站
    • 表单外链
      • 表单外链
      • 数据外链
      • 公开查询
      • 外链限制
    • 表单内链
      • 表单访问内链
      • 数据详情内链
    • 表单属性
      • 表单属性介绍
      • 表单提交校验
      • 表单提交确认设置
      • 功能扩展设置
      • 表单数据缓存
      • 多标签显示
      • 隐藏控件赋值
      • 表单外链样式
      • 字段显隐规则
      • 提交操作设置
      • 表单布局
    • 表单权限
      • 表单 报表权限设置
      • 普通表单数据权限管理
      • 流程表单数据权限管理
    • 扩展体系支持并行触发
    • 引用关系
  • 表单设置
    • 提交扩展
    • 打印功能
      • 打印模板基本功能
      • 模板设计-在线模式
      • 模板设计-word模式
      • 模板使用范围
      • 案例1:在线模式-自定义模板
      • 案例2:在线模式实现套打
      • 案例3:word模式实现套打
    • 推送提醒
      • 提醒设置
        • 新数据提交时提醒
        • 数据修改后提醒
        • 自定义时间提醒
        • 根据表单中的日期字段提醒
        • 数据被评论@时提醒
        • 提醒方式
          • 微信提醒
          • 短信提醒
          • 邮件提醒
          • 语音提醒
      • 消息模板
        • 钉钉消息模板
        • 短信消息模板
        • 飞书消息模板
        • 企业微信消息模板
        • 微信消息模板
        • 邮件消息模板
        • 语音消息模板
        • 消息推送入口
        • 关于微信公众号消息模板调整通知
    • 计划任务
    • 字段索引
    • 微信增强
  • 公式设计
    • 公式规则
    • 表单VS助手视图公式对照表
    • 逻辑函数
      • IF 条件判断
      • TRUE、FALSE 布尔型
      • AND 与运算
      • OR 或运算
      • NOT 非运算
      • XOR 异或运算
      • IFS 多条件判断
      • ISNULL 返回值无效判断
    • 文本函数
      • CONCATENATE 文本合并
      • CONCAT 文本合并
      • EXACT 文本比较
      • LEN 取长度
      • LOWER 大写转小写
      • UPPER 小写转大写
      • SEARCH 查找
      • SPLIT 分割
      • TRIM 删除字符串首尾空格
      • TEXT 转换文本
      • VALUE 文本转数字
      • ISEMPTY 判断是否为空
      • GETUSERNAME 获取用户昵称
      • MD5 加密
      • CHAR 换行
      • ADDRESS2TEXT 地址转文本
      • TEXT2ADDRESS 文本转地址
      • LOCATION2ADDRESS 经纬度转地址
      • STR_MID 取中间
      • STR_LEFT 取左
      • STR_RIGHT 取右
      • STR_REPLACE 文本替换
      • STR_REPT 重复
      • REPLACE_EX 新旧文本替换
      • STR_VALUE 文本转数字
      • STR_SPLIT 文本分割
      • URLDECODE 解码
      • URLENCODE 编码
      • RMBCAP 金额转换
      • JOIN 将数组值连接成文本
      • UNION 剔除重复数据
    • 数学函数
      • AVERAGE 平均数
      • COUNT 计数
      • COUNTIF 统计满足条件的参数个数
      • LARGE 从大到小排序取值
      • SMALL 从小到大排序取值
      • MAX 取最大值
      • MIN 取最小值
      • ABS 取绝对值
      • CEILING 向上舍入
      • FLOOR 向下舍入
      • INT 求整
      • LOG 对数
      • MOD 取余数
      • PRODUCT 乘积
      • POWER 乘幂
      • SUM 求和
      • SUMPRODUCT 乘积和
      • RAND 随机数
      • ISNAN 判断计算空值
      • MATH_ROUND 四舍五入
      • MATH_SQRT 平方根
      • COS 计算余弦值
      • COT 计算余切值
      • RADIANS 将角度转化为弧度
      • SIN 计算正弦值
      • SUMIF 满足某一条件的数字之和
      • SUMIFS 满足多个条件的数字之和
      • SUMPRODUCT 计算数组间对应元素的乘积之和
      • TAN 计算正切值
      • MATH_SUMPRODUCT 计算数组间对应元素的乘积之和
      • ACOS 反余弦函数
      • ASIN 正弦逆函数
      • ATAN 反正切函数
      • DEGREES 将弧度转换成角度
      • EXP 返回 e的 n次方
    • 日期函数
      • DATE 时间戳转日期
      • TIMESTAMP 日期转时间戳
      • TIME 时间十进制
      • TODAY 今天
      • NOW 当前时间
      • SYSTIME 服务器时间
      • DAY 日
      • MONTH 月
      • YEAR 年
      • HOUR 小时
      • MINUTE 分钟
      • SECOND 秒数
      • DAYS 计算日期间隔天数
      • DAYS360 计算日期间隔天数
      • DATEDELTA 加减指定天数
      • EDATE 加减指定月数
      • WEEKNUM 周数
      • ISOWEEKNUM ISO周数
      • DATEDIFF 计算时间差值
      • DATEFORMAT 指定日期格式
      • NETWORKDAYS 计算两个日期之间完整的工作日数值
      • WEEKDAY 计算日期的星期数
      • WORKDAY 计算指定天数后的日期
    • 高级函数
      • MAPX 聚合操作
      • UUID 随机码生成器
      • RECNO 累积器
      • IP 获取用户IP地址
      • DISTANCE 计算距离
      • GETUSERNAME 获取当前用户的昵称
      • INDEX 获取数组中指定位置的值
      • FX_INDEX 获取数组中指定位置的值
    • 子表单函数
      • SUBFORMLESS 小于
      • SUBFORMGREATER 大于
      • SUBFORMEQUAL 等于
      • SUBFORMLESSOREQUAL 小于等于
      • SUBFORMGREATEROREQUAL 大于等于
      • SUBFORMNOTEQUAL 不等于
    • 历史函数
      • LEFT 取左
      • RIGHT 取右
      • MID 取中间
      • REPT 重复
      • REPLACE 文本替换
      • ROUND、FIXED 四舍五入
      • SQRT 平方根
  • 数据关联与联动
    • 规则介绍
    • 数据关联VS数据联动VS数据加载VS功能插件
    • 数据关联
    • 数据联动
    • 数据加载
    • 子表单数据加载
    • 数据联动支持多条件
    • 多级联动
    • 子表单联动
  • 数据管理与协作
    • 数据管理VS报表-数据表VS查看表单所有数据
    • 数据导入导出
    • 特殊控件导入
    • 数据管理
    • 数据动态与评论
    • 数据分享
    • 批量修改
    • 批量打印
    • 批量导出附件
    • 批量打印二维码
    • 批量调整流程负责人
    • 批量结束流程
    • 数据协作介绍
    • 数据协作使用方法
    • Excel导入导出图片
    • 数据权限
      • 普通表单数据权限
      • 流程表单数据权限
      • 表单数据权限举例
      • 成员部门过滤方式
      • 全部有数据权限的数据
    • 数据标题
    • 表格快捷编辑
    • 数据管理搜索数据
    • 数据回收站
    • 数据复制
  • 流程设计
    • 流程介绍
    • 流程节点设计
      • 建立节点间流程关系
      • 数据流转条件和流转规则
      • 节点连线与过滤条件
      • 流程结束节点
    • 节点属性设置
      • 流程负责人
      • 抄送
      • 操作权限
      • 审批意见
      • 节点权限
        • 流程回退
        • 流程加签
      • 节点校验条件
      • 负责人为空处理规则
      • 流程节点限时处理
        • 限时处理
        • 自动提醒
        • 自动提交
        • 自动回退
      • 提交不触发提醒
    • 流程属性设置
      • 流程提醒
      • 流程撤回
      • 流程催办
      • 流程状态和日志
      • 评论
      • 流程决策
      • 流程自动提交规则
      • 流程简报是否使用最新数据呈现
    • 子流程
      • 案例-出差与报销
    • 流程使用
      • 工作台流程管理
      • 应用内流程管理
      • 搜索&筛选条件
      • 批量提交与数据刷新
    • 流程监管
      • 管理员监控流程
    • 流程时效统计
  • 报表设计
    • 基础报表
      • 数据表
      • 数据菜单冻结
      • 文本控件
      • 日历
      • 透视图
      • 指标
      • 甘特图
      • 图片控件
    • 分析图表
      • 分析图表操作介绍
      • 柱形图
      • 折线图
      • 条形图
      • 饼图
      • 面积图
      • 雷达图
      • 双轴图
      • 地图
      • 漏斗图
      • 仪表盘
    • 场景报表
      • 地图场景报表
      • 卡片场景报表
      • 外部网页场景报表
    • 报表权限
      • 基础报表报表权限
      • 分析图表报表权限
      • 场景报表报表权限
      • 报表外链
      • 报表访问内链
      • 报表共享
    • 显示字段
    • 维度
    • 指标
    • 同比环比
    • 数据格式
    • 报表样式
    • 辅助线
    • 图表联动
    • 图表自定义联动
    • 筛选条件和筛选按钮
    • 过滤条件
    • 过滤条件和筛选条件
    • 图片预览
    • 移动布局
    • 报表菜单
      • 数据表菜单栏
      • 报表菜单栏
      • 菜单栏权限专题
      • 报表菜单实例欣赏
    • 报表排序
      • 数据表排序
      • 指标图排序
      • 透视图排序
      • 图形表排序
    • 报表定时提醒
    • 报表刷新
    • 筛选模式设置
    • 查看原始数据
    • 引用关系
  • 聚合表
    • 聚合表介绍
    • 聚合表设计
    • 聚合表多表关联
    • 聚合表其他设置
    • 聚合表案例赏析
    • 聚合表与数据视图
  • 数据视图
    • 视图介绍
    • 视图设计
    • 刷新规则
    • 数据输入
    • 数据处理
      • 横向连接
      • 追加合并
      • 数据筛选
      • 分组汇总
      • 字段设置
        • 排名
        • 累加汇总(求累计值)
      • 字段排序
      • 行转列
      • 节点设置
      • 输出表
    • 案例赏析
    • 数据视图与聚合表
  • 数据助手
    • 数据助手介绍
    • 数据助手使用
      • 助手配置入口
        • 控件触发
        • 初始化触发
        • 数据操作触发
        • 流程操作触发
        • 报表菜单触发
        • 数据导入触发
        • 计划任务触发
      • 助手使用设计
        • 输入数据
          • 输入数据
          • 数据源
          • 子表单当前行
        • 数据处理
          • 横向连接
          • 追加合并
          • 数据筛选
          • 分组汇总
          • 字段设置
            • 排名
            • 累加汇总(求累计值)
          • 字段排序
          • 行转列
          • 输出表
        • 执行动作
          • 新增数据
          • 修改数据
          • 删除数据
          • 数据联动
          • 子表单联动
          • 消息推送
          • 功能插件
          • 其他设置
        • 通用设置
          • 通用设置
          • 前置后置
          • 数据助手日志
    • 数据助手案例
      • 数据助手子表单
        • 子表单单行联动
        • 子表单批量联动
        • 子表单内联动多表
        • 普通字段添加到子表单
        • 筛选子表单数据到普通字段
        • 子表单数据同步
        • 子表单聚合计算
      • 数据助手计划任务
        • 计划任务发起流程
        • 计划任务删除数据
      • 数据助手智能助手
        • 数据去重
        • 数据合并
        • 加载上次提交值
        • 多字段匹配
        • 数据助手关联数据
        • 联动数据到当前表
  • 功能插件
    • 功能插件介绍
    • 功能插件使用
      • 控件功能插件使用示例
      • 表单功能插件使用示例
      • 流程功能插件使用示例
      • 计划任务功能插件使用示例
      • 触发方式
      • 表单操作类型
    • 数据助手VS功能插件
    • 阻塞与非阻塞
  • 前端事件
    • 前端事件介绍
    • 前端事件配置
    • JsonPath规则详解
    • 子表单字段写入数组
    • 场景应用
      • 阿里云接口-物流查询
      • 阿里云接口-天气查询
      • 开放平台接口-查询成员列表
  • 应用设置
    • 页面共享
    • 跨应用
    • 自定义菜单
    • 应用日志
    • 应用管理
  • 历史功能
    • Web API
      • API打印
      • POST接口
      • 表单&数据API
      • 通讯录API
  • 其他
    • 数据管理更新日志
    • 关于钉钉飞书去除IP说明
    • 功能模块正式更名为功能插件的通知
    • 关于PDF文件预览兼容性问题的说明

表单&数据API

  • 简介
    • 使用须知
    • 名词解释
  • 表单API
    • 查询表单字段
  • 数据API
    • 查询多条数据
    • 排序查询数据
    • 数据筛选器
    • 查询单条数据
    • 新增数据
    • 批量新增数据
    • 编辑数据
    • 删除数据
  • 控件与数据类型对照表
  • API操作关联关系

简介

本章节介绍了表单&数据API的具体参数和返回值,包含表单字段查询接口、查询多条数据接口、根据排序查询多条数据接口、查询单条数据接口、新建单条数据接口、修改单条数据接口、删除单条数据接口。

使用须知

开发前,请仔细阅读开发指南。

  • POST请求头
{"Authorization": "Bearer YOUR_APIKEY"}
  • YOUR_APIKEY请阅读开发指南了解。

名词解释

名称 说明
app_id 应用ID
entry_id 该应用内的表单ID

app_id+entry_id表示全局唯一的表单标识,前往系统管理中的API文档进行查看。

表单API

查询表单字段

POST - /api/v1/app/{app_id}/entry/{entry_id}/widgets

获取指定表单的控件/字段信息,除分割线控件和关联查询控件以外。

具体可以查阅文档末尾的控件与数据类型对照表。

  • 请求参数:
{}
  • 响应内容:
{
    "widgets": [{
        "name": "单行文本",
        "title": "单行文本",
        "type": "text"
    },
    {
        "name": "多行文本",
        "title": "多行文本",
        "type": "textarea"
    },
    {
        "name": "数字",
        "title": "数字",
        "type": "number"
    },
    {
        "name": "日期时间",
        "title": "日期时间",
        "type": "datetime"
    },
    {
        "name": "单选按钮组",
        "title": "单选按钮组",
        "type": "radiogroup"
    },
    {
        "name": "复选框组",
        "title": "复选框组",
        "type": "checkboxgroup"
    },
    {
        "name": "下拉复选框",
        "title": "下拉复选框",
        "type": "combocheck"
    },
    {
        "name": "下拉框",
        "title": "下拉框",
        "type": "combo"
    },
    {
        "name": "定位",
        "title": "定位",
        "type": "location"
    },
    {
        "name": "地址",
        "title": "地址",
        "type": "address"
    },
    {
        "name": "附件",
        "title": "附件",
        "type": "upload"
    },
    {
        "name": "图片",
        "title": "图片",
        "type": "image"
    },
    {
        "name": "子表单",
        "title": "子表单",
        "type": "subform",
        "data": [{
            "name": "子表单单行文本",
            "title": "单行文本",
            "type": "text"
        },
        {
            "name": "子表单多行文本",
            "title": "多行文本",
            "type": "textarea"
        }]
    },
    {
        "name": "关联数据",
        "title": "关联数据",
        "type": "linkdata"
    },
    {
        "name": "手写签名",
        "title": "手写签名",
        "type": "signature"
    },
    {
        "name": "成员单选",
        "title": "成员单选",
        "type": "user"
    },
    {
        "name": "成员多选",
        "title": "成员多选",
        "type": "usergroup"
    },
    {
        "name": "部门单选",
        "title": "部门单选",
        "type": "dept"
    },
    {
        "name": "部门多选",
        "title": "部门多选",
        "type": "deptgroup"
    }]
}

返回表单字段结构信息。

参数 类型 说明
widgets array 控件信息
widgets[].name string 控件别名
widgets[].title string 控件标题
widgets[].type string 控件类型,每种控件类型都有对应的数据类型
widgets[].data array 仅子表单控件有,数组里包含了每个子控件的信息

数据API

查询多条数据

POST - /api/v1/app/{app_id}/entry/{entry_id}/data

该接口的返回数据,始终按照提交时间正序排列。

  • 请求参数:
{
    "data_id": "53b6b1251b4eab93d38cb33b",
    "fields": ["单行文本", "多行文本", "数字", "日期时间", "下拉框", "下拉复选框"],
    "limit": 100,
    "filter": {
        "rel": "and",
        "cond": [{
            "field": "单行文本",
            "method": "not_empty"
        },
        {
            "field": "多行文本",
            "method": "not_empty"
        },
        {
            "field": "数字",
            "method": "gt",
            "value": [0]
        }]
    }
}
参数 必需 类型 说明
data_id 否 string 上一次查询数据结果的最后一条数据的ID,没有则留空
fields 否 array 需要查询的数据字段
limit 否 number 查询的数据条数,1~100,默认100
filter 否 json 数据筛选器,详情规则查看后续介绍
  • 响应内容:
{
    "data": [{
        "appId": "5d995d2c4e6dfe89f4b8ccaa",
        "entryId": "5d31cec8902295850d0ea658",
        "_id": "55a06d676fc567faaa726521",
        "单行文本": "文本内容1",
        "多行文本": "第一行文本\n第二行文本\n第三行文本",
        "数字": "123",
        "日期时间": "2021-11-26 00:00:00",
        "下拉框": "选项1",
        "下拉复选框": ["选项1", "选项2"]
    },
    {
        "appId": "5d995d2c4e6dfe89f4b8ccaa",
        "entryId": "5d31cec8902295850d0ea658",
        "_id": "54b21b2009dda422133572a5",
        "单行文本": "文本内容2",
        "多行文本": "第一行文本\n第二行文本\n第三行文本",
        "数字": "123",
        "日期时间": "2021-11-27 00:00:00",
        "下拉框": "选项2",
        "下拉复选框": ["选项2", "选项3"]
    }]
}

返回查询数据信息。

参数 类型 说明
data array 多条数据的集合

注意: 查询到的数据内容中,除了控件字段以外,还有一些系统字段。

系统字段 字段别名 数据类型 数据样例 备注
应用ID appId string "5d995d2c4e6dfe89f4b8ccaa" appId+entryId保证表单ID的唯一性
表单ID entryId string "5d31cec8902295850d0ea658" appId+entryId保证表单ID的唯一性
数据ID _id string “5bb6e4e013d46e148a9da655” 全局唯一
提交人 creator json {"_id": “575ffc5e885898ce0d2afe41”, “name”: “小云”} -
提交时间 createTime string “2019-01-01 10:10:10” -
修改人 updater json {"_id": “575ffc5e885898ce0d2afe41”, “name”: “小云”} -
修改时间 updateTime string “2019-01-01 10:10:10” -
删除人 deleter json {"_id": “575ffc5e885898ce0d2afe41”, “name”: “小云”} -
删除时间 deleteTime string “2019-01-01 10:10:10” -
流程状态(仅流程表单) number flowState 0 该字段仅流程表单支持。
2表示流程手动结束
1表示流程已结束
0表示流程进行中

排序查询数据

POST - /api/v1/app/{app_id}/entry/{entry_id}/data_by_sort
  • 请求参数:
{
    "limit": 100,
    "skip": 0,
    "fields": ["_widget_1499052693182", "_widget_1499052693195", "_widget_1499052693206"],
    "filter": {
        "rel": "and",
        "cond": [{
            "field": "_widget_1499052693182",
            "method": "empty"
        },
        {
            "field": "_widget_1499052693195",
            "method": "not_empty"
        },
        {
            "field": "_widget_1499052693206",
            "method": "empty"
        }]
    },
    "sort": {
        "_widget_1499052693182": "desc",
        "_widget_1499052693195": "asc"
    }
}
参数 必需 类型 说明
limit 否 number 查询的数据条数,1~100,默认100
skip 否 number 翻页起始值索引
fields 否 array 需要查询的数据字段
filter 否 json 数据筛选器
sort 否 json 排序(asc:正序;desc:倒序),排序不限制字段数量

以下控件类型不可作为排序字段:复选框组、下拉复选框、地址、定位、图片、附件、手写签名、成员单选、成员多选、部门单选、部门多选。

  • 响应内容:
{
    "data": {
        "appId": "5b88531dc22c4e4c7755116f",
        "entryId": "56e26c5747ae8869481b417f",
        "_id": "5bb6e4e013d46e148a9da655",
        "_widget_1555926403587": "张三",
        "_widget_1555926403600": "张三",
        "_widget_1555926403640": 7,
        "_widget_1555926403652": "2019-01-01 10:10:10",
        "creator": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        },
        "createTime": "2019-01-01 10:10:10",
        "updateTime": "2019-01-01 10:10:10",
        "updater": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        },
        "deleter": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        }
    }
}

数据筛选器

查询数据接口同时也支持过滤条件,可通过filter参数进行数据过滤。

  • 筛选参数结构如下:
参数 必需 类型 说明
rel 是 string 筛选组合关系;“and”(满足所有过滤条件), “or”(满足任一过滤条件)
cond 是 [json] 过滤条件列表
  • 过滤条件参数如下:
参数 必需 类型 说明
field 是 string 字段名
method 是 string 过滤方法;
eq(等于)
ne(不等于)
all(同时包含)
in(等于任意一个)
nin(不等于任意一个)
like(包含)
unlike(不包含)
empty(为空)
not_empty(不为空)
gt(大于)
gte(大于等于)
lt(小于)
lte(小于等于)
range(选择范围,在x与y之间,并且包含x和y本身)
value 否 array 过滤值
hasEmpty 否 Boolean 是否未填写
  • 目前支持如下字段:
字段类型 支持的过滤方式 说明
flowState eq,ne 流程状态,仅对流程表单有效
日期时间/数字/提交时间/更新时间 eq,ne,gt,gte,lt,lte,range,empty,not_empty -
单行文本/下拉框/单选按钮组 eq,ne,in,nin,like,unlike,empty,not_empty -
多行文本 like,unlike,empty,not_empty -
附件/图片/手写签名 empty,not_empty -
定位/地址 empty,not_empty,all,nin -
复选框组/下拉复选框 eq,empty,not_empty,all,in -
成员单选/部门单选/提交人 eq,ne,in,nin,empty,not_empty -
成员多选/部门多选 in,all,eq,empty,not_empty -
  • 筛选示例:
{
    "filter": {
        "rel": "and",
        // 或者 "or"
        "cond": [
        // 过滤条件
        {
            "field": "flowState",
            "method": "eq",
            "value": [1]
        },
        {
            "field": "图片",
            "method": "empty"
        },
        {
            "field": "单行文本",
            "method": "in",
            "value": ["apple", "pen"]
        },
        {
            "field": "时间",
            "method": "range",
            "value": ["2019-06-11 00:00:00", "2019-06-28 23:59:59"]
        },
        {
            "field": "多行文本",
            "method": "like",
            "value": ["ddd"] //包含“ddd”的数据
        }]
    }
}

查询单条数据

POST - /api/v1/app/{app_id}/entry/{entry_id}/data_retrieve

按照指定数据ID获取表单中的数据。

  • 请求参数:
{
    "data_id": "59e9a2fe283ffa7c11b1ddbf"
}
参数 必需 类型 说明
data_id 是 string 数据ID
  • 响应内容:
{
    "data": {
        "appId": "539543cee19942ea8bb5e744",
        "entryId": "50dafd850f3fc191513f2f21",
        "_id": "5bb6e4e013d46e148a9da655",
        "_widget_1558765248187": "张三",
        "聚合表验证数字": 7,
        "多行文本": "webapi",
        "数字": 7,
        "日期时间": "2019-01-01 10:10:10",
        "单选按钮组": "一年级",
        "复选框组": ["选项1", "选项2"],
        "下拉复选框": ["选项1", "选项2"],
        "下拉框": "女",
        "定位": {
            "province": "湖南省",
            "city": "长沙市",
            "district": "芙蓉区",
            "detail": "韶山北路86号鑫天大厦",
            "lnglatXY": [113.002864, 28.199614]
        },
        "地址": {
            "province": "湖南省",
            "city": "长沙市",
            "district": "芙蓉区",
            "detail": "韶山北路86号鑫天大厦"
        },
        "_widget_1558929030197": [{
            "name": "私有云介绍.pdf",
            "size": 524288,
            "mime": "application/pdf",
            "url": "http://qiniu.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
        },
        {
            "name": "定制介绍.pdf",
            "size": 524288,
            "mime": "application/pdf",
            "url": "http://qiniu.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
        }],
        "图片": [{
            "name": "bby.png",
            "size": 3762,
            "mime": "image/png",
            "url": "http://qiniu.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
        },
        {
            "name": "image2.png",
            "size": 3762,
            "mime": "image/png",
            "url": "http://qiniu.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
        }],
        "子表单": [{
            "子表单单行文本": "张三",
            "子表单多行文本": "系统webapi"
        }],
        "_widget_1558929030271": {
            "id": "5b237548b22ab14884086cc0",
            "key": "系统"
        },
        "_widget_1558929030284": {
            "name": "signature_1238921858.png",
            "size": 1024,
            "mime": "image/png",
            "url": "http://qiniu.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
        },
        "成员单选": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        },
        "成员多选": [{
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        },
        {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小宝"
        }],
        "部门单选": {
            "_id": "59daab24c91306a9239b7ca0",
            "name": "经理部"
        },
        "部门多选": [{
            "_id": "59daab24c91306a9239b7ca0",
            "name": "经理部"
        },
        {
            "_id": "59daab24c91306a9239b7ca1",
            "name": "市场部"
        }],
        "creator": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        },
        "createTime": "2019-01-01 10:10:10",
        "updateTime": "2019-01-01 10:10:10",
        "updater": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        },
        "deleter": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        }
    }
}
参数 类型 说明
data json 单条数据

新增数据

POST - /api/v1/app/{app_id}/entry/{entry_id}/data_create

在指定表单中添加一条数据。

请注意:使用API添加数据时,会触发的事件有新数据提交提醒、聚合表计算&校验、数据量统计。也可以通过请求参数来控制是否发起流程、触发数据助手&功能插件&后端事件,但是不会触发重复值校验和必填校验。

另外系统字段和分割线、手写签名、关联数据、关联查询不支持添加和修改数据。

  • 请求参数:
{
    "data": {
        "_widget_1558765248187": "张三",
        "聚合表验证数字": 8,
        "多行文本": "webapi",
        "数字": 8,
        "日期时间": "2019-01-01 11:11:11",
        "单选按钮组": "一年级",
        "复选框组": ["选项1", "选项2"],
        "下拉复选框": ["选项1", "选项2"],
        "下拉框": "女",
        "定位": {
            "province": "湖南省",
            "city": "长沙市",
            "district": "芙蓉区",
            "detail": "韶山北路",
            "lnglatXY": [112.99627, 28.19393]
        },
        "地址": {
            "province": "湖南省",
            "city": "长沙市",
            "district": "芙蓉区",
            "detail": "韶山北路"
        },
        "图片": [--格式1:直接传入图片url "https://doc.com/static/index/images/tu_1_03.png", --格式2:以数组方式传入图片url {
            "url": "https://doc.com/static/index/images/tu_1_03.png"
        },
        --格式3:以数组方式传入图片url和自定义图片名称 {
            "url": "https://doc.com/static/index/images/tu_1_03.png",
            "name": "test.png"
        }],
        "子表单": [{
            "子表单单行文本": "张三",
            "子表单多行文本": "宜点云webapi"
        },
        {
            "子表单单行文本": "李四",
            "子表单多行文本": "宜点云"
        }],
        "成员单选": "5af263d45e67aaf5b09033c7",
        "成员多选": ["5af263d45e67aaf5b09033c7", "5af263d45e67aaf5b09033c9"],
        "部门单选": "5af263d45e67aaf5b09033c7",
        "部门多选": ["5af263d45e67aaf5b09033c7", "5af263d45e67aaf5b09033c9"]
    },
    "is_start_workflow": true,
    "is_start_event": true,
    "operator": ""
}
参数 必需 类型 说明
data 是 json 数据内容
is_start_workflow 否 Boolean 用来控制是否触发流程,默认不触发流程
is_start_event 否 Boolean 是否触发功能扩展设置(数据助手、插件事件、后端事件)
operator 否 string 操作人_id,默认使用应用所有者的_id
  • 响应内容:
{
    "data": {
        "appId": "5d995d2c4e6dfe89f4b8ccaa",
        "entryId": "5d31cec8902295850d0ea658",
        "creator": {
            "name": "金睦",
            "_id": "519311e456fcb477cbf840d0"
        },
        "deleter": null,
        "updater": null,
        "createTime": "2021-11-26 21:13:59",
        "updateTime": "2021-11-26 21:13:59",
        "deleteTime": null,
        "_id": "5036ab0e8668ccee27fa65e1",
        "_widget_1558765248187": "张三",
        "聚合表验证数字": 8,
        "多行文本": "webapi",
        "数字": 8,
        "日期时间": "2019-01-01 11:11:11",
        "单选按钮组": "一年级",
        "复选框组": ["选项1", "选项2"],
        "下拉复选框": ["选项1", "选项2"],
        "下拉框": "女",
        "定位": {
            "province": "湖南省",
            "city": "长沙市",
            "district": "芙蓉区",
            "detail": "韶山北路",
            "lnglatXY": [112.99627, 28.19393]
        },
        "地址": {
            "province": "湖南省",
            "city": "长沙市",
            "district": "芙蓉区",
            "detail": "韶山北路"
        },
        "图片": [--格式1:直接传入图片url "https://doc.com/static/index/images/tu_1_03.png", --格式2:以数组方式传入图片url {
            "url": "https://doc.com/static/index/images/tu_1_03.png"
        },
        --格式3:以数组方式传入图片url和自定义图片名称 {
            "url": "https://doc.com/static/index/images/tu_1_03.png",
            "name": "test.png"
        }],
        "子表单": [{
            "子表单单行文本": "张三",
            "子表单多行文本": "宜点云webapi"
        },
        {
            "子表单单行文本": "李四",
            "子表单多行文本": "宜点云"
        }],
        "成员单选": "5af263d45e67aaf5b09033c7",
        "成员多选": ["5af263d45e67aaf5b09033c7", "5af263d45e67aaf5b09033c9"],
        "部门单选": "5af263d45e67aaf5b09033c7",
        "部门多选": ["5af263d45e67aaf5b09033c7", "5af263d45e67aaf5b09033c9"]
    }
}
参数 类型 说明
data json 返回提交后的完整数据,内容同查询单条数据接口

批量新增数据

POST - /api/v1/app/{app_id}/entry/{entry_id}/batch_data_create

在指定表单中添加多条数据。

请注意:使用API添加数据时,会触发的事件有新数据提交提醒、聚合表计算&校验、数据量统计。也可以通过请求参数来控制是否发起流程、触发数据助手&功能插件&后端事件,但是不会触发重复值校验和必填校验。

限制100条 超出报错

另外系统字段和分割线、手写签名、关联数据、关联查询不支持添加和修改数据。

  • 请求参数:
{
    "datas": [{
        "单行文本": "webapi多条发起",
        "成员单选": "55cb7d57f7a190e382857117"
    },
    {
        "单行文本": "webapi发起1",
        "成员单选": "55cb7d57f7a190e382857117"
    }],
    "is_start_workflow": false,
    "is_start_event": false,
    "operator": ""
}
参数 必需 类型 说明
datas 是 json 数据内容
is_start_workflow 否 Boolean 用来控制是否触发流程,默认不触发流程
is_start_event 否 Boolean 是否触发功能扩展设置(数据助手、插件事件、后端事件)
operator 否 string 操作人_id,默认使用应用所有者的_id
  • 响应内容:
{
    "success": [{
        "appId": "5d89dec9547d284a4bf5fb62",
        "entryId": "58417ecfad8d8e341c9e8ab8",
        "creator": {
            "name": "张三",
            "_id": "51616fa9c2668f496283094c"
        },
        "deleter": null,
        "updater": null,
        "createTime": "2021-06-30 14:27:42",
        "updateTime": "2021-06-30 14:27:42",
        "deleteTime": null,
        "_id": "52de26c07ad2173baf8d5b31",
        "flowState": "0",
        "单行文本": "webapi多条发起",
        "成员单选": {
            "name": "阿举",
            "_id": "55cb7d57f7a190e382857117"
        }
    },
    {
        "appId": "5d89dec9547d284a4bf5fb62",
        "entryId": "58417ecfad8d8e341c9e8ab8",
        "creator": {
            "name": "张三",
            "_id": "51616fa9c2668f496283094c"
        },
        "deleter": null,
        "updater": null,
        "createTime": "2021-06-30 14:27:42",
        "updateTime": "2021-06-30 14:27:42",
        "deleteTime": null,
        "_id": "5358703fe081160cf4114769",
        "flowState": "0",
        "单行文本": "webapi发起1",
        "成员单选": {
            "name": "阿举",
            "_id": "55cb7d57f7a190e382857117"
        }
    }],
    "failed": [{
        "单行文本": "webapi多条发起2",
        "成员单选": "55cb7d57f7a190e382857117"
    },
    {
        "单行文本": "webapi多条发起5",
        "成员单选": "55cb7d57f7a190e382857117"
    }],
    "failedCode": [4009, 4009]
}
参数 类型 说明
success json 成功的数据结果
failed json 失败的原数据
failedCode array 失败对应的错误码code

编辑数据

POST - /api/v1/app/{app_id}/entry/{entry_id}/data_update

按照指定数据ID修改表单中的数据。

请注意:使用API修改数据时,会触发的事件有聚合表计算&校验、数据量统计。也可以通过请求参数来控制是否触发数据助手&功能插件&后端事件,不进行重复值校验、必填校验等。

  • 请求参数:
{
    "data_id": "5bb6e4e013d46e148a9da655",
    "data": {
        "单行文本": "张三",
        "多行文本": "webapi",
        "数字": 8,
        "日期时间": "2019-01-01 11:11:11",
        "下拉框": "女",
        "下拉复选框": ["选项1", "选项2"]
    },
    "is_start_event": true,
    "operator": ""
}
参数 必需 类型 说明
data_id 是 string 数据ID
data 是 json 数据内容,同数据提交
is_start_event 否 Boolean 是否触发功能扩展设置(数据助手、插件事件、后端事件)
operator 否 string 操作人_id,默认使用应用所有者的_id
  • 响应内容:
{
    "data": {
        "appId": "5d995d2c4e6dfe89f4b8ccaa",
        "entryId": "5d31cec8902295850d0ea658",
        "_id": "张三",
        "单行文本": "张三",
        "多行文本": "webapi",
        "数字": 7,
        "日期时间": "2019-01-01 10:10:10",
        "下拉框": "女",
        "下拉复选框": ["选项1", "选项2"],
        "creator": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        },
        "createTime": "2019-01-01 10:10:10",
        "updateTime": "2019-01-01 10:10:10",
        "updater": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        },
        "deleter": {
            "_id": "575ffc5e885898ce0d2afe41",
            "name": "小云"
        }
    }
}
参数 类型 说明
data json 返回修改后的新数据,内容同查询单条数据接口

删除数据

POST - /api/v1/app/{app_id}/entry/{entry_id}/data_delete

按照指定数据ID从表单中删除数据,删除的数据进入回收站。

也可以通过请求参数来控制是否发起流程、触发数据助手&功能插件&后端事件。

  • 请求参数:
{
    "data_id": "5bb6e4e013d46e148a9da655",
    "is_start_event": false,
    "operator": ""
}
参数 必需 类型 说明
data_id 是 string 数据ID
is_start_event 否 Boolean 是否触发功能扩展设置(数据助手、插件事件、后端事件)
operator 否 string 操作人_id,默认使用应用所有者的_id
  • 响应内容:
{
    "status": "success"
}

返回删除结果。

参数 类型 说明
status string 返回请求结果,success为成功。

控件与数据类型对照表

控件名称 控件类型 数据类型 数据样例 备注
单行文本 text string “张三”
多行文本 textarea string “宜点云webapi”
数字 number Number 7
日期时间 datetime string “2019-01-01 11:10:11”
单选按钮组 radiogroup string “一年级”
复选框组 checkboxgroup Array [“选项1”,“选项2”]
下拉框 combo string “女”
下拉复选框 combocheck Array [“选项1”,“选项2”]
地址 address json {province: "湖南省", city: "长沙市", district: "芙蓉区", detail: "袁家岭"}
定位 location json {province: "湖南省", city: "长沙市", district: "芙蓉区", detail: "袁家岭", lnglatXY: [113.002864, 28.199614]} lnglatXY表示[经度, 纬度]
图片 image Array [ { "name": "img.png", "size": 3762, "mime": "image/png", "url": "https://qiniu.XXX.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2" }, { "name": "img1.png", "size": 3762, "mime": "image/png", "url": "https://qiniu.XXX.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2" } ] 数据中包含的url为图片链接
附件 upload Array [ { "name": "接口.pdf", "size": 37602, "mime": "application/pdf", "url": "https://qiniu.XXX.com/FvXfzy2nqPP12YP5cTeH6bUVp2" }, { "name": "宜点云.pdf", "size": 37602, "mime": "application/pdf", "url": "https://qiniu.XXX.com/FvXfzy2nqPP12YP5cTeH6X4Vp2" } ] 数据中包含的url为附件链接
子表单 subform Array
关联数据 linkdata json {“id”:“5b237548b22ab14884086cc0”,“key”:“接口”} id表示所关联数据的ID;key表示主键字段的值
手写签名 signature json {“name”:“signature_1238921857.png”,“size”:1024,“mime”:“image/png”,“url”:“https://qiniu.XXX.com/FvXfzy2nqPP12YP5cTeH6X4p2”} 数据中包含的url为手写签名的图片链接
成员单选 user json { "name": "小云", "_id": "55cb7d57f7a190e382857189" } 成员信息中_id表示宜点云中的用户id;name表示用户昵称
成员多选 usergroup Array [ { "name": "小云", "_id": "55cb7d57f7a190e382857189" }, { "name": "小宝", "_id": "575ffc5e885898ce0d2af791" } ]
部门单选 dept json  { "name": "销售部", "_id": "59daab24c91306a9239b7ca0" }
部门多选 deptgroup Array [ { "name": "销售部", "_id": "59daab24c91306a9239b7ca0" }, { "name": "人事部", "_id": "5014a86b688ff0ec55a946d9" } ]

API操作关联关系

- create update delete
数据消息推送 记录 记录 不记录
触发聚合表 记录 记录 记录
数据动态 记录 记录 记录
事件/插件 可记录 可记录 可记录
重复值校验 不校验 不校验 -
表单校验 不校验 不校验 -
必填校验 不校验 不校验 -
流程节点校验 不校验 不校验 -
触发流程 可记录 不记录 -
聚合表校验 校验 校验 校验
字段联动、公式 不记录 不记录 -
最新修改于:2023-07-06