Skip to main content

​
1. 迭代背景

本次对宜搭原有的 openAPI 进行升级迭代，旨在为宜搭的开发者（如ISV服务商或有接口调用需求的宜搭用户）提供数量更多，使用更流畅的开发能力，极大程度上释放开发者的开发潜力。

​
2. 迭代内容列表

本次更新迭代涉及4 个模块共 14 个接口的更新与调整，下架 11 个无法使用的接口，分别是：
模块接口名称及使用文档链接功能描述适用场景细节说明
平台查询宜搭表单服务调用执行记录根据宜搭表单Id查询对应的服务调用执行记录信息，包括服务调用状态、服务调用地址和服务调用结果等。例如，企业宜搭应用数据管理列表中，其中一个表单实例的服务调用记录如下图，调用本接口获取服务调用记录详情信息。
—
查询宜搭应用列表用于查询组织下的宜搭应用列表，包括宜搭应用状态、宜搭应用图标和宜搭应用编码等。例如，宜搭应用如下图所示，调用本接口获取企业内宜搭应用详情信息。
—
数据查询或操作通过高级检索条件查询表单实例使用筛选条件获取表单实例详情。在如下图所示页面，输入筛选条件查询满足条件的表单实例。例如，可输入表单提交人、创建的开始时间等信息进行筛选。
1.切换至新版搜索存储结构，查询数据上限由 5000 条提升至 30000 条。
2.由原来的仅支持模糊搜索变为现在的支持精确/模糊搜索。
3.对于所有查询类接口，如果有入参searchFieldJson，那么该入参现在支持“数据管理”使用的查询条件，详情参考 采用表单“数据管理”的过滤条件进行条件搜索 。
4.获取流程实例 接口 新增 orderConfigJson入参，可指定排序规则。如何填写此参数请参考可参与搜索结果排序的内置字段。
查询表单实例数据调用本接口查询表单实例数据。
获取流程实例用于获取宜搭的流程实例信息，包括实例Id、创建时间、发起人等信息。例如，企业宜搭应用内的流程列表如下截图，调用本接口获取流程实例的详情信息。
获取子表单数据调用本接口通过表单实例ID和子表单组件唯一标识获取子表组件数据。—
获取主表数据用于单独查询主表数据。如果表单页面里含有大量子表单组件(不是大量子表单实例)导致“查询表单数据”OpenAPI超时，那么可以将步骤拆分成2步来解决超时问题：
第1步：使用 获取主表数据 查询主表数据。
第2步：使用 获取子表单数据 查询需要的子表单数据。
新增或更新表单实例根据筛选条件筛选表单实例，满足筛选条件则根据指定表单值更新符合查询条件的表单实例，如果不存在满足筛选条件的表单实例，则根据指定表单值新增一条表单实例。
原始数据

存在满足条件数据

不存在满足条件数据则新增		适用于：OpenAPI（不论是开放平台还是前端接口）需要受业务关联规则约束，如校验单据编号的唯一值。（目前存在重复的很难被察觉，无法直接透视出来，例如目前每次写入前会查询这个唯一值字段是否存在，一条数据要调用2个以上接口）
批量操作批量创建表单实例用于批量创建表单实例数据，返回新增表单实例的Id。例如，企业宜搭应用的数据管理中宜搭实例列表如下图所示，调用本接口在宜搭实例列表中新增一个报销项目为“批量新增表单实例”的实例。

表单原始数据

调用成功后数据
  1. 如果选择不执行业务规则，那么 同步/异步 单次批量创建表单实例允许的数量是 100 条。
  2. 如果选择执行业务规则

    批量删除表单实例用于批量删除表单实例数据，从表单实例列表中移除。例如，企业宜搭应用数据管理中的实例列表如下图所示，列表内有四个宜搭表单实例，调用本接口删除第一个宜搭实例。

    表单原始数据

    调用成功后表单数据
    1. 如果选择不执行业务规则，那么 同步/异步 单次批量创建表单实例允许的数量是 500条。
    2. 如果选择执行业务规则

      批量更新表单实例内的组件值根据宜搭表单实例Id，批量更新宜搭表单实例的组件值。例如，企业宜搭应用的表单实例列表如下图，调用本接口批量更新四个表单内报销项目组件值。将报销项目的值修改为更新报销项目。

      表单原始数据

      成功调用后表单数据
      1. 如果选择不执行业务规则，那么 同步/异步 单次批量创建表单实例允许的数量是 500条。
      2. 如果选择执行业务规则

        通过表单实例数据批量更新表单实例根据宜搭表单组件数据，批量更新表单实例信息。例如，企业宜搭应用的数据管理列表如图所示，四个宜搭表单实例都使用了报销项目组件，调用本接口可通过更新报销项目组件内的值，实现更新这四个宜搭表单。

        表单原始数据

        成功调用后表单数据
        批量获取表单实例数据用于批量获取表单实例详情信息，包括实例名称、实例提交人等信息。例如，企业宜搭应用数据管理中的宜搭实例列表如下截图，调用本接口，根据实例Id批量查询列表内实例的详情信息。
        组件保存表单数据（单个创建）调用本接口新增一条无审批流程的宜搭表单实例。
        批量创建同批量创建表单实例———
        其他宜搭平台自调用接口不稳定解决：searchFieldJson.json偶发性地长时间查不出数据, 尤其是添加了loading之后更为明显(刷新之后即可)问题解决方案：用户可使用 /dingtalk/web/APP_PR185LWG5XWYCPITZ58C/query/formProcInstData/getInstanceDatasLight.json 可设定每次查询时的子表数据量大小。—
        下架以下接口
        		———
        对接口分类进行重新归纳整理：
        • “任务”分类下的部分接口调整到“表单/流程”分类下。
        		———