百宝云 | 帮助中心
  • 帮助文档
  • 功能模块
  • 后端开发
  • 专题详解
  • 常见问题
  • 更新日志
  • 视频学院
返回控制台
  • 返回控制台
  • 百宝云简介
  • 百宝云新版功能简介
  • 快速入门
    • 百宝云账号注册
    • 表单、报表新建与共享
    • 应用管理
    • 从excel导入创建表单
    • 表单、流程表单与报表的区别
    • 平台性能解释
      • 什么是用户数
      • 什么是数据量
      • 什么是流量
  • 工作台
    • 应用管理
      • 任务待办
      • 应用分组
      • 应用排序
      • 创建新应用
      • 快捷操作
      • 应用分享给他人安装
      • 导出安装包
    • 账户中心
      • 基础
      • 会员中心
      • 财务
      • 已安装模块
      • 安全
      • 语言包
    • 消息中心
      • 消息类型
      • 通知设置
      • 消息接收人管理
  • 通讯录管理
    • 成员
    • 组织架构
    • 设置部门主管
    • 子管理员
    • 角色
  • 表单设计
    • 表单控件
      • 控件基础说明
      • 单行文本
      • 多行文本
      • 数字
      • 日期时间
      • 按钮
      • 分割线
      • 地址
      • 定位
      • 图片
      • 附件
      • 子表单
        • 子表单补充说明
        • 子表单数据加载
      • 关联查询
      • 关联数据
      • 手写签名
      • 流水号
      • 数据加载
      • 下拉框和单选按钮组
      • 复选框和下拉复选框
      • 成员和部门
      • 控件设计常用功能
        • 字段名称下添加超链接
        • 字段上添加图片
        • 收集外部数据
        • 公开查询
        • 下拉框和下拉复选框字段排序
    • 表单属性
      • 表单校验
      • 表单布局
      • 模块设置
      • 表单数据缓存
      • 记录访问来源
      • 隐藏控件赋值
    • 公式详解
      • 公式规则
      • 逻辑函数
        • AND 与运算
        • OR 或运算
        • TRUE/FALSE 布尔型
        • IF 条件判断
        • NOT 非运算
        • XOR 异或运算
        • IFS 多条件判断
      • 文本函数
        • CONCATENATE 文本合并
        • EXACT 文本比较
        • LEFT 取左
        • RIGHT 取右
        • MID 取中间
        • LEN 取长度
        • LOWER 大写转小写
        • UPPER 小写转大写
        • REPLACE 文本替换
        • REPT 重复
        • SEARCH 查找
        • SPLIT 分割
        • TRIM 删除字符串收尾空格
        • TEXT 数字转文本
        • VALUE 文本转数字
        • ISEMPTY 判断是否为空
        • GETUSERNAME 获取用户昵称
        • MD5 md5加密
        • CHAR 换行
      • 数学函数
        • AVERAGE 平均数
        • COUNT 计数
        • COUNTIF 统计满足条件的个数
        • LARGE 取大值
        • MAX 取最大值
        • MIN 取最小值
        • SMALL 取小值
        • ABS 取绝对值
        • ROUND/FIXED 四舍五入
        • CEILING 向上舍入
        • FLOOR 向下舍入
        • INT 求整
        • LOG 对数
        • MOD 取余数
        • POWER 乘幂
        • PRODUCT 乘积
        • SQRT 平方根
        • SUM 求和
        • SUMPRODUCT 乘积和
        • RAND 随机数
        • ISNAN 判断计算空值
      • 日期函数
        • DATE 时间戳转日期
        • TIMESTAMP 日期转时间戳
        • TIME 时间十进制
        • TODAY 今天
        • NOW 当前时间
        • SYSTIME 服务器时间
        • DAY 日
        • MONTH 月
        • YEAR 年
        • HOUR 小时
        • MINUTE 分钟
        • SECOND 秒数
        • DAYS 时间间隔
        • DAYS360 日期间相差的天数
        • DATEDELTA 加/减指定天数
        • WEEKNUM 周数
        • ISOWEEKNUM ISO周数
        • DATEDIFF 两个时间的差值
      • 高级函数
        • MAPX 聚合操作
        • UUID 随机码生成器
        • RECNO 累积器
        • IP 获取用户IP地址
      • 子表单函数
        • SUBFORMLESS 小于
        • SUBFORMGREATER 大于
        • SUBFORMEQUAL 等于
        • SUBFORMLESSOREQUAL 小于等于
        • SUBFORMGREATEROREQUAL 大于等于
        • SUBFORMNOTEQUAL 不等于
    • 数据关联与联动
      • 规则介绍
      • 数据关联
      • 数据联动
      • 多级联动
      • 子表单联动
    • 实例讲解
      • 选项关联控件
  • 流程表单
    • 设计
      • 建立节点和流程关系
      • 节点连线-过滤条件
      • 流转规则
      • 流程结束节点
      • 流程负责人
      • 节点校验
      • 操作权限
      • 抄送
      • 流程提醒
      • 流程撤回
      • 节点权限
      • 审批意见
      • 流程状态和日志
      • 激活流程
      • 流程决策
      • 流程版本
      • 流程节点限时处理
        • 自动提醒
        • 自动提交
        • 自动回退
      • 子流程
        • 案例-出差与报销
    • 使用
      • 工作台的流程信息
      • 流程管理
      • 筛选条件
      • 批量提交与数据刷新
    • 监管
      • 管理员监控流程
    • 流程案例与常见问题
      • 会签流程
      • 条件流程
      • 并发流程
      • 案例1:报销
      • 节点校验与流转条件的对比
      • 流程节点的打印模版选择
  • 数据管理与协作
    • 导出表样、导入数据
    • 特殊控件的数据导入
    • 数据管理
    • 数据权限
      • 普通表单数据权限
      • 流程表单数据权限
      • 表单数据权限举例
    • 数据动态与评论
    • 数据分享
    • 批量修改
    • 批量打印
    • 批量打印二维码
    • 批量调整负责人
    • 批量结束流程
    • 数据协作介绍
    • 数据协作使用方法
    • Excel导入导出图片
  • 表单设置
    • 提交提示
    • 多标签显示
    • 打印功能介绍
      • 模板设计
      • 模板使用范围
      • 案例1:自定义模板
      • 案例2:套打
    • 推送提醒
      • 提醒设置
        • 新数据提交时提醒
        • 数据修改后提醒
        • 自定义时间提醒
        • 根据表单中的日期字段提醒
      • 提醒方式
    • 计划任务
    • 字段索引
    • 微信增强
  • 分析报表
    • 数据表
      • 数据表菜单栏
    • 日历
    • 后端表
    • 图形表
      • 图形表的属性与特点
      • 双轴图
      • 辅助线
      • 颜色设置
      • 图表联动
      • 图表自定义联动
      • 同比环比
      • 地图
    • 文本组件
    • 筛选条件
    • 排序
      • 数据表排序
      • 指标排序
      • 透视图排序
      • 图表排序
        • 柱形图、条形图、面积图排序
        • 折线图、雷达图排序
        • 饼图排序
    • 报表菜单栏
    • 数据菜单冻结
    • 报表权限
      • 基础报表
      • 分析报表
      • 场景报表
    • 过滤条件
    • 数据格式
    • 图片预览
    • 案例:数据表-菜单操作
    • 老报表
      • 报表权限
      • 数据表
      • 数据表移动端卡片样式
      • 汇总表
      • 柱形图
      • 折线图
      • 饼图
      • 面积图
      • 雷达图
      • 排班表
      • 日历
      • 地图
      • 报表查询条件
      • 报表条件过滤
      • 报表联动
      • 多表关联
        • 多表关联规则
        • 数据表多表关联
      • 显示格式
      • 汇总逻辑
  • 场景报表
    • 卡片
    • 地图
  • 权限设置
    • 表单/报表分享
    • 普通表单数据权限管理
    • 流程表单数据权限管理
  • 数据视图
    • 认识数据视图
    • 新建视图
      • 视图设计
      • 视图节点选择
        • 横向连接
        • 追加合并
        • 数据筛选
        • 分组汇总
        • 字段设置
        • 字段排序
        • 含有子表单的数据源处理
        • 节点设置
        • 输出表
    • 案例:多渠道订单汇总
  • 外链使用
    • 对外收集数据
    • 对外展示数据
    • 外链扩展
    • 报表外链权限
    • 表单外链样式
    • 外链限制
  • 事件表单
    • 事件表单
    • 事件流程表单
    • 后端开发
    • 初始化事件
    • 提交事件
    • 控件事件的触发
    • 前置触发后置触发
  • 应用设置
    • 页面共享
    • 移动自定义菜单
    • 应用发布
    • 应用日志
    • 应用管理
    • 聚合表
      • 聚合表介绍
      • 案例1:进销存
  • 高级功能
    • 数据回收站
    • 批量导出附件
    • 跨应用
    • Web API
      • 开发指南
      • 表单&数据API
      • 通讯录API
      • POST接口
    • 安装多模块
    • 控件回收站
    • 安全策略
    • 单点登录
      • 开发指南
      • SAML2.0配置
      • 自定义接口配置
  • 企业微信
    • 企业微信账号创建与应用添加
    • 百宝云普通账号绑定企业微信
    • 通讯录同步及修改
    • 企业微信第三方应用通讯录授权
    • 在企业微信使用百宝云的方式
    • 应用权限设置
    • 企业微信管理员账号与成员账号的区别
  • 收费版本介绍
    • 套餐购买
    • 套餐购买升级续费
  • 移动端帮助手册
    • 工作台
    • 应用
    • 我的
    • 流程管理
  • 数据助手
    • 数据助手介绍
    • 新建数据助手
      • 设计数据助手
      • 节点选择
        • 输入数据
          • 输入数据
          • 数据源
          • 输入数据含有子表单的处理
        • 数据处理
          • 横向连接
          • 追加合并
          • 数据筛选
          • 分组汇总
          • 字段设置
          • 字段排序
        • 执行动作
          • 新增数据
          • 修改数据
          • 删除数据
          • 功能模块
          • 数据联动
          • 其他设置
        • 输出表
        • 节点基础设置
    • 案例-修改商品信息单价
表单&数据API
阅读人数:

978

  • 开发准备
  • 应用举例
    • API & 订单管理
    • API & 项目管理
  • 字段别名
  • 表单API
    • POST - /api/v1/app/{app_id}/entry/{entry_id}/widgets 表单字段查询接口
  • 数据API
    • POST - /api/v1/app/{app_id}/entry/{entry_id}/data 查询多条数据接口
    • POST-/api/v1/app/{app_id}/entry/{entry_id}/data_by_sort 根据排序查询多条数据接口
    • 数据筛选器
    • POST - /api/v1/app/{app_id}/entry/{entry_id}/data_retrieve 查询单条数据接口
    • POST - /api/v1/app/{app_id}/entry/{entry_id}/data_create 新建单条数据接口
    • POST - /api/v1/app/{app_id}/entry/{entry_id}/data_update 修改单条数据接口
    • POST - /api/v1/app/{app_id}/entry/{entry_id}/data_delete 删除单条数据接口
  • 控件与数据类型对照表
  • API操作关联关系

开发准备

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

注:以下所有接口路径中的app_id和entry_id分别表示应用ID和该应用内的表单ID,因此app_id+entry_id表示全局唯一的表单ID,前往系统管理中的API文档进行查看。

应用举例

API & 订单管理

在百宝云中建立了一个订单表单,用于统计订单信息。销售渠道一般分为线上商城销售和线下销售,线下销售通常需要销售手动在百宝云中录入订单。但是线上渠道用户自主下单后会生成一个订单,此时这个订单可以通过新增单条数据API接口直接在百宝云中生成一条订单记录,这样我们就不需要一个人专门把网上的订单一条条手动录入百宝云。手动录入不仅工作量很大,而且容易出错。

API & 项目管理

当使用百宝云做项目管理流程控制时,一般财务收款都是有单独的一套系统,此时可以通过修改单条数据API接口将财务软件中的收款信息推送到百宝云来,从而修改对应的项目信息。

字段别名

字段别名(控件别名)默认为系统自动生成的数值字符串,可以修改。

表单API

POST - /api/v1/app/{app_id}/entry/{entry_id}/widgets 表单字段查询接口

获取指定表单的控件/字段信息,除分割线控件和关联查询控件以外。具体可以查阅文档最后的 控件与数据类型对照表。

请求参数: 无

响应内容:

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

响应数据样例:

{
    "widgets": [
        {
            "name": "_widget_1558765248187",
            "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": "_widget_1558929030197",
            "title": "附件",
            "type": "upload"
        },
        {
            "name": "图片",
            "title": "图片",
            "type": "image"
        },
        {
            "name": "子表单",
            "title": "子表单",
            "type": "subform",
            "data": [
                {
                    "name": "子表单单行文本",
                    "title": "单行文本",
                    "type": "text"
                },
                {
                    "name": "子表单多行文本",
                    "title": "多行文本",
                    "type": "textarea"
                }
            ]
        },
        {
            "name": "_widget_1558929030271",
            "title": "关联数据",
            "type": "linkdata"
        },
        {
            "name": "_widget_1558929030284",
            "title": "手写签名",
            "type": "signature"
        },
        {
            "name": "成员单选",
            "title": "成员单选",
            "type": "user"
        },
        {
            "name": "成员多选",
            "title": "成员多选",
            "type": "usergroup"
        },
        {
            "name": "部门单选",
            "title": "部门单选",
            "type": "dept"
        },
        {
            "name": "部门多选",
            "title": "部门多选",
            "type": "deptgroup"
        }
    ]
}

数据API

POST - /api/v1/app/{app_id}/entry/{entry_id}/data 查询多条数据接口

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

请求参数:

参数 必需 类型 说明
data_id String 上一次查询数据结果的最后一条数据的ID,没有则留空
fields Array 需要查询的数据字段
filter JSON 数据筛选器
limit Number 查询的数据条数,1~100,默认100

请求示例:

{
    "data_id":"53b6b1251b4eab93d38cb33b",
    "fields":["_widget_1558765248187","多行文本","数字","子表单"],
    "limit":10,
    "filter":{
        "rel": "and",
        "cond": [
            {
                "field":"creator",
                "method":"in",
                "value":["575ffc5e885898ce0d2afe41", "56979d1d1eea475f2848249b"]
            },
            {
                "field": "_widget_1558765248187",
                "method": "eq",
                "value":[454],
                "hasEmpty":true
            },
            {
                "field":"数字",
                "method":"ne",
                "value":[666]
            }
        ]
    }
}


响应参数:

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


响应数据样例:

{
    "data": [
        {
            "appId": "539543cee19942ea8bb5e744",
            "entryId": "56af3c8b7f7f039c93108be8",
            "_id": "5bb6e4e013d46e148a9da655",
            "_widget_1558765248187": "454",
            "多行文本": "sdfsdf",
            "数字": "-666.55"
        },
        {
            "appId": "539543cee19942ea8bb5e744",
            "entryId": "56af3c8b7f7f039c93108be8",
            "_id": "5bbfe3ab42ba31e44c5be199",
            "_widget_1558765248187": "454",
            "多行文本": "sdfsdf",
            "数字": "-666.55"
        }
    ]
}

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

如下表:

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

POST-/api/v1/app/{app_id}/entry/{entry_id}/data_by_sort 根据排序查询多条数据接口

请求参数:

参数 必须 类型 说明
limit Number 查询的数据条数,1~100,默认100
skip Number 翻页起始值索引
fields Array 需要查询的数据字段
filter JSON 数据筛选器
sort JSON 排序(asc:正序;desc:倒序),不限制排序字段的数量,复选框组、下拉复选框、地址、定位、图片、附件、手写签名、成员单选、成员多选、部门单选、部门多选不可作为排序字段

请求示例:

{
    "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"
    }
}

响应数据样例:

{
    "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 Bool 是否未填写

目前支持如下字段:

字段类型 支持的过滤方式 说明
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 是 String 数据ID

请求示例:

POST /api/v1/app/59264073a2a60c0c08e20bfb/entry/59264073a2a60c0c08e20bfd/data_retrieve

{
    "data_id": "59e9a2fe283ffa7c11b1ddbf"
}

响应参数:

参数 类型 说明
data JSON 单条数据

响应数据样例:

{
    "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.baibaoyun.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
            },
            {
                "name": "定制介绍.pdf",
                "size": 524288,
                "mime": "application/pdf",
                "url": "http://qiniu.baibaoyun.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
            }
        ],
        "图片": [
            {
                "name": "bby.png",
                "size": 3762,
                "mime": "image/png",
                "url": "http://qiniu.baibaoyun.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
            },
            {
                "name": "image2.png",
                "size": 3762,
                "mime": "image/png",
                "url": "http://qiniu.baibaoyun.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2"
            }
        ],
        "子表单": [
            {
                "子表单单行文本": "张三",
                "子表单多行文本": "百宝云webapi"
            }
        ],
        "_widget_1558929030271": {
            "id": "5b237548b22ab14884086cc0",
            "key": "百宝云"
        },
        "_widget_1558929030284": {
            "name": "signature_1238921858.png",
            "size": 1024,
            "mime": "image/png",
            "url": "http://qiniu.baibaoyun.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": "小云"
        }
    }
}

POST - /api/v1/app/{app_id}/entry/{entry_id}/data_create 新建单条数据接口

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

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

另外,系统字段 和 以下所列举的控件 不支持添加和修改数据:

  • 分割线
  • 手写签名
  • 关联数据、关联查询

请求参数:

参数 必需 类型 说明
data 是 JSON 数据内容
is_start_workflow 否 Boolean 用来控制是否触发流程,默认不触发流程
is_start_event 否 Boolean 是否触发事件(模块事件/_form事件)
operator 否 String 操作人_id,默认使用应用所有者的_id

请求示例:

{
    "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": "韶山北路"
        },
        "图片": [
            "https://doc.baibaoyun.com/static/index/images/tu_1_03.png",
            "https://www.baibaoyun.com/static/index/images/tu_1_03.png"
        ],
        "子表单": [
            {
                "子表单单行文本": "张三",
                "子表单多行文本": "百宝云webapi"
            },
        {
                "子表单单行文本": "李四",
                "子表单多行文本": "百宝云"
            }
        ],
        "成员单选": "5af263d45e67aaf5b09033c7",
        "成员多选": [
            "5af263d45e67aaf5b09033c7",
            "5af263d45e67aaf5b09033c9"
        ],
        "部门单选": "5af263d45e67aaf5b09033c7",
        "部门多选": [
            "5af263d45e67aaf5b09033c7",
            "5af263d45e67aaf5b09033c9"
        ]
    },
    "is_start_workflow": true,
    "is_start_event": true,
    "operator": ""
}

响应参数

参数 类型 说明
data JSON 返回提交后的完整数据,内容同查询单条数据接口

响应数据样例

{
    "data": {}
}

POST - /api/v1/app/{app_id}/entry/{entry_id}/data_update 修改单条数据接口

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

请注意: 使用API修改数据时,会触发的事件有聚合表计算&校验、数据量统计。不进行重复值校验、必填校验等。

请求参数:

参数 必需 类型 说明
data_id 是 String 数据ID
data 是 JSON 数据内容,同数据提交
is_start_event 否 Boolean 是否触发事件(模块事件/_form事件)
operator 否 String 操作人_id,默认使用应用所有者的_id

请求示例:

{
    "data_id": "59264073a2a60c0c08e20bfb",
    "data": {}
}

响应参数:

参数 类型 说明
data JSON 返回修改后的新数据,内容同查询单条数据接口

响应数据样例:

{
    "data": {}
}

POST - /api/v1/app/{app_id}/entry/{entry_id}/data_delete 删除单条数据接口

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

请求参数:

参数 必需 类型 说明
data_id 是 String 数据ID
is_start_event 否 Boolean 是否触发事件(模块事件/_form事件)
operator 否 String 操作人_id,默认使用应用所有者的_id

响应数据样例:

{
    "status": "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.baibaoyun.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2" }, { "name": "img1.png", "size": 3762, "mime": "image/png", "url": "https://qiniu.baibaoyun.com/FvXfzy2nqPP12YP5cTeH6bUX4Vp2" } ] 数据中包含的url为图片链接
附件 upload Array [ { "name": "接口.pdf", "size": 37602, "mime": "application/pdf", "url": "https://qiniu.baibaoyun.com/FvXfzy2nqPP12YP5cTeH6bUVp2" }, { "name": "百宝云.pdf", "size": 37602, "mime": "application/pdf", "url": "https://qiniu.baibaoyun.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.baibaoyun.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
数据消息推送 记录 记录 不记录
触发聚合表 记录 记录 记录
数据动态 记录 记录 记录
事件/模块 可记录 可记录 可记录
重复值校验 不校验 不校验 -
表单校验 不校验 不校验 -
必填校验 不校验 不校验 -
流程节点校验 不校验 不校验 -
触发流程 可记录 不记录 -
聚合表校验 校验 校验 校验
字段联动、公式 不记录 不记录 -