2022.04.21 版本更新-OpenAPI 全新升级
版本范围：所有版本可用 不依赖新建应用 已全量发布 已发布到钉钉开放平台
1. 升级概述
为更好的支持 ISV 或宜搭开发者的强需求，宜搭通过 OpenAPI 极大程度上释放服务商的潜力，提供更多的开放接口能力。
升级目标：
- 实现 openAPI 对全部标准组件的支持
- 对用户常用的数据 CRUD 接口性能提升（解决超时/失败率高的问题）
- 增强 API 可用性/易用性
- 钉钉开放平台 openAPI 文档可读性增强（如增加接口参数说明、接口命名优化等）
- 表单 CRUD 批量操作的接口支持
- 部分高频场景开放 open API 进行支持
钉钉开放平台【宜搭】新增以下接口：
- 新增通过高级查询条件获取表单实例数据（不包括子表单组件数据）接口，用于使用高级检索条件查询宜搭表单实例数据，但不返回表单里的子表单实例数据(解决表单内子表单过多导致的 API 超时问题)。
- 新增批量获取表单实例数据接口，用于批量获取宜搭表单实例数据信息。
- 新增批量删除表单实例接口，用于批量删除宜搭表单实例。
- 新增批量创建表单实例接口，用于批量创建宜搭表单实例。
- 新增批量更新表单实例内的组件值接口，用于批量更新宜搭表单实例。
- 新增通过表单组件数据批量更新表单实例接口，用于修改指定组件值更新宜搭表单实例。
- 新增新增或更新表单实例接口，用于根据筛选条件筛选表单实例，满足筛选条件则根据指定表单值更新符合查询条件的表单实例，如果不存在满足筛选条件的表单实例，则根据指定表单值新增一条表单实例。
- 新增查询宜搭应用列表接口，用于获取企业的宜搭应用列表。
- 新增通过高级检索条件查询表单实例接口，用于使用高级检索条件筛选宜搭审批实例。
- 新增查询宜搭表单服务调用执行记录接口，用于查询某个宜搭表单实例的服务调用记录。
2. 能力介绍
2.1 OpenAPI 高频场景明细升级清单
模块 | 接口名称 | 功能描述（用户反馈原声） | 钉钉开放平台接口文档 | 备注说明 |
平台 | 查询服务调用记录 | 宜搭服务回调日志开放接口 | ||
获取组织下的宜搭应用列表 | 增加获取组织所有APP 详情列表的接口 | https://open.dingtalk.com/document/orgapp-server/query-the-application-list | ||
数据查询或操作 | 通过高级检索条件查询表单实例 查询表单实例数据 获取流程实例 | 宜搭开放接口单次查询允许查询超过5000条数据，支持3W 条 | https://open.dingtalk.com/document/orgapp-server/querying-form-instance-data https://open.dingtalk.com/document/orgapp-server/obtain-process-instance | 切换至新版搜索存储结构，列表查询上限从 5000 提升至3W |
通过高级检索条件查询表单实例 获取流程实例 查询表单实例数据 | 单行文本通过API接口查询的能选择模糊搜索者精确搜索 | https://open.dingtalk.com/document/orgapp-server/obtain-process-instance https://open.dingtalk.com/document/orgapp-server/querying-form-instance-data | before：模糊搜索, 操作符默认为contains After：支持精确/模糊搜索 对于所有查询类接口，如果有入参searchFieldJson，那么该入参现在支持“数据管理”使用的查询条件，详情参考 采用表单“数据管理”的过滤条件进行条件搜索 | |
获取流程实例 | 外部调用【根据搜索条件获取实例详情】接口加上审批节点的筛选功能 | https://open.dingtalk.com/document/orgapp-server/obtain-process-instance | searchFieldJson 入参现在支持“数据管理”使用的查询条件，详情参考 采用表单“数据管理”的过滤条件进行条件搜索 | |
获取流程实例 | 据条件查询实例详情列表中参数中建议增加排序字段 | https://open.dingtalk.com/document/orgapp-server/obtain-process-instance | 新增orderConfigJson入参，可指定排序规则， 如何填写此参数请参考可参与搜索结果排序的内置字段。 | |
获取子表组件数据 | 新增单独查询子表接口 | https://open.dingtalk.com/document/orgapp-server/obtain-child-table-component-data | ||
获取主表数据 | 新增单独查询主表接口 | |||
新增或更新表单实例 | 新增 upsert 接口 | https://open.dingtalk.com/document/orgapp-server/add-or-update-form-instances | 适用于：OpenAPI（不论是开放平台还是前端接口）需要受业务关联规则约束，如校验单据编号的唯一值。（目前存在重复的很难被察觉，无法直接透视出来，例如目前每次写入前会查询这个唯一值字段是否存在，一条数据要调用2个以上接口） | |
批量操作 | 批量创建表单实例数据 | 增加批量新增接口 | https://open.dingtalk.com/document/orgapp-server/create-multiple-form-instances |
|
批量删除指定的多个表单实例ID对应的表单实例数据 | 增加批量删除接口 | https://open.dingtalk.com/document/orgapp-server/delete-multiple-form-instances |
| |
将多条表单实例的指定表单组件值更新成指定值
| 增加批量修改接口 | https://open.dingtalk.com/document/orgapp-server/batch-update-of-component-values-in-form-instances |
| |
批量获取表单实例数据 | 增加批量查询接口 | https://open.dingtalk.com/document/orgapp-server/obtain-multiple-form-instance-data | ||
组件 | （批量）创建表单实例 | 实现 OpenAPI 对全部标准组件的支持，新增支持图片上传组件 | 【批量创建】https://open.dingtalk.com/document/orgapp-server/create-multiple-form-instances 【单个创建】 https://open.dingtalk.com/document/orgapp-server/save-form-data | |
其他 | 宜搭平台自调用接口不稳定 | searchFieldJson.json偶发性地长时间查不出数据, 尤其是添加了loading之后更为明显(刷新之后即可) | 解决方案：用户可使用 /dingtalk/web/APP_PR185LWG5XWYCPITZ58C/query/formProcInstData/getInstanceDatasLight.json 可设定每次查询时的子表数据量大小。 |
2.2 钉钉开放平台 open API 变更内容：
- 用户无法使用或暂不需要的接口文档已下架，如下图
- 接口分类重新归纳调整
- “任务”分类下的部分接口调整到“表单/流程”分类下。
3. 意见反馈
如果在使用【宜搭 openAPI 】中遇到问题或有建议反馈，可以扫描下方二维码，加入「宜搭体验中心」进行意见反馈。
--------------------获取宜搭最新信息，欢迎关注我们--------------------
