> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 宜搭 openAPI 迭代说明

> 本次对宜搭原有的 openAPI 进行升级迭代，旨在为开发者提供数量更多、使用更流畅的开发能力。更新涉及4个模块共14个接口的更新与调整，并下架了11个无法使用的接口。

## 1. 迭代背景

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

## 2. 迭代内容列表

本次更新迭代涉及**4 个模块共 14 个接口的更新与调整**，**下架 11 个无法使用的接口**，分别是：

<table>
  <tr>
    <td>**模块**</td>
    <td>**接口名称及使用文档链接**</td>
    <td>**功能描述**</td>
    <td>**适用场景**</td>
    <td>**细节说明**</td>
  </tr>

  <tr>
    <td rowSpan={2}>**平台**</td>
    <td>[查询宜搭表单服务调用执行记录](https://open.dingtalk.com/document/orgapp-server/the-query-should-be-based-on-the-execution-records-of)</td>
    <td>根据宜搭表单Id查询对应的服务调用执行记录信息，包括服务调用状态、服务调用地址和服务调用结果等。</td>
    <td>例如，企业宜搭应用数据管理列表中，其中一个表单实例的服务调用记录如下图，调用本接口获取服务调用记录详情信息。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650523969559-8eb38f2c-3a6c-4e6e-921c-463375e65a53.png)</td>
    <td>--</td>
  </tr>

  <tr>
    <td>[查询宜搭应用列表](https://open.dingtalk.com/document/orgapp-server/query-the-application-list)</td>
    <td>用于查询组织下的宜搭应用列表，包括宜搭应用状态、宜搭应用图标和宜搭应用编码等。</td>
    <td>例如，宜搭应用如下图所示，调用本接口获取企业内宜搭应用详情信息。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650524060518-966c1a5e-7f4c-424c-8af8-3854224983bf.png)</td>
    <td>--</td>
  </tr>

  <tr>
    <td rowSpan={6}>**数据查询或操作**</td>
    <td>[通过高级检索条件查询表单实例](https://open.dingtalk.com/document/orgapp-server/query-form-instances-using-advanced-search-conditions)</td>
    <td>使用筛选条件获取表单实例详情。</td>
    <td>在如下图所示页面，输入筛选条件查询满足条件的表单实例。例如，可输入表单提交人、创建的开始时间等信息进行筛选。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650524193606-07024c9a-eabd-4728-9d18-916afd5c8c98.png)</td>
    <td rowSpan={3}>1.切换至新版搜索存储结构，查询数据上限由 **5000** 条提升至 **30000** 条。<br />2.由原来的仅支持模糊搜索变为现在的支持精确/模糊搜索。<br />3.对于所有查询类接口，如果有入参`searchFieldJson`，那么该入参现在支持“数据管理”使用的查询条件，详情参考 [采用表单“数据管理”的过滤条件进行条件搜索](https://docs.aliwork.com/docs/yida_support/lbtl0t/rrwdug/athbne/agb8im) 。<br />4.[获取流程实例](https://open.dingtalk.com/document/orgapp-server/obtain-process-instance) 接口 新增 `orderConfigJson`入参，可指定排序规则。如何填写此参数请参考[可参与搜索结果排序的内置字段](https://docs.aliwork.com/docs/yida_support/lbtl0t/rrwdug/athbne/agb8im)。</td>
  </tr>

  <tr>
    <td>[查询表单实例数据](https://open.dingtalk.com/document/orgapp-server/querying-form-instance-data)</td>
    <td>调用本接口查询表单实例数据。</td>
    <td>![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650524284259-1c1360b6-b074-42e1-b1fe-17fd0347c547.png)</td>
  </tr>

  <tr>
    <td>[获取流程实例](https://open.dingtalk.com/document/orgapp-server/obtain-process-instance)</td>
    <td>用于获取宜搭的流程实例信息，包括实例Id、创建时间、发起人等信息。</td>
    <td>例如，企业宜搭应用内的流程列表如下截图，调用本接口获取流程实例的详情信息。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650524436975-90e0b61d-437a-4753-b64f-40aeca2343de.png)</td>
  </tr>

  <tr>
    <td>[获取子表单数据](https://docs.aliwork.com/docs/yida_support/yida_updates/mw0bmqngpgz6sxba/xe1y54)</td>
    <td>调用本接口通过表单实例ID和子表单组件唯一标识获取子表组件数据。</td>
    <td>![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650528529035-aa7963ed-50ff-4414-8b4a-a779e0858e1e.png)</td>
    <td>--</td>
  </tr>

  <tr>
    <td>获取主表数据</td>
    <td>用于单独查询主表数据。</td>
    <td>![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1651907906990-8a3d83e8-2c65-40a5-8fc9-9ece55d7af92.png)</td>
    <td>如果表单页面里含有大量子表单组件(不是大量子表单实例)导致“查询表单数据”OpenAPI超时，那么可以将步骤拆分成2步来解决超时问题：<br />第1步：使用 获取主表数据 查询主表数据。<br />第2步：使用 [获取子表单数据](https://docs.aliwork.com/docs/yida_support/yida_updates/mw0bmqngpgz6sxba/xe1y54) 查询需要的子表单数据。</td>
  </tr>

  <tr>
    <td>[新增或更新表单实例](https://open.dingtalk.com/document/orgapp-server/add-or-update-form-instances)</td>
    <td>根据筛选条件筛选表单实例，满足筛选条件则根据指定表单值更新符合查询条件的表单实例，如果不存在满足筛选条件的表单实例，则根据指定表单值新增一条表单实例。</td>
    <td>![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650529093143-367a121f-1dbc-48af-a530-9a6bbd945dca.png)<br />原始数据<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650530435594-b94627b3-0406-47d0-b8f2-e830471eff59.png)<br />存在满足条件数据<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650530464288-80b0f78a-2a11-4f10-8def-a0a6f5186fc4.png)<br />不存在满足条件数据则新增</td>
    <td>适用于：OpenAPI（不论是开放平台还是前端接口）需要受业务关联规则约束，如校验单据编号的唯一值。（目前存在重复的很难被察觉，无法直接透视出来，例如目前每次写入前会查询这个唯一值字段是否存在，一条数据要调用2个以上接口）</td>
  </tr>

  <tr>
    <td rowSpan={5}>**批量操作**</td>
    <td>[批量创建表单实例](https://open.dingtalk.com/document/orgapp-server/create-multiple-form-instances)</td>
    <td>用于批量创建表单实例数据，返回新增表单实例的Id。</td>
    <td>例如，企业宜搭应用的数据管理中宜搭实例列表如下图所示，调用本接口在宜搭实例列表中新增一个报销项目为“批量新增表单实例”的实例。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650530672888-b918cb30-b5cb-4c95-a0d2-15c2e2f33aa7.png)<br />表单原始数据<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650530690692-23a5fcb4-1577-4f9f-a8bf-db06fea0ed30.png)<br />调用成功后数据</td>
    <td><ol><li>如果选择不执行业务规则，那么 同步/异步 单次批量创建表单实例允许的数量是 **100** 条。</li><li>如果选择执行业务规则</li></ol><br /><ol /></td>
  </tr>

  <tr>
    <td>[批量删除表单实例](https://open.dingtalk.com/document/orgapp-server/delete-multiple-form-instances)</td>
    <td>用于批量删除表单实例数据，从表单实例列表中移除。</td>
    <td>例如，企业宜搭应用数据管理中的实例列表如下图所示，列表内有四个宜搭表单实例，调用本接口删除第一个宜搭实例。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650530921629-25917abb-ef51-412f-9600-a39ea02cb7a7.png)<br />表单原始数据<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650530955282-f4893e0d-29c8-446c-8019-d943ad803b09.png)<br />调用成功后表单数据</td>
    <td><ol><li>如果选择不执行业务规则，那么 同步/异步 单次批量创建表单实例允许的数量是 **500**条。</li><li>如果选择执行业务规则</li></ol><br /><ol /></td>
  </tr>

  <tr>
    <td>[批量更新表单实例内的组件值](https://open.dingtalk.com/document/orgapp-server/batch-update-of-component-values-in-form-instances)</td>
    <td>根据宜搭表单实例Id，批量更新宜搭表单实例的组件值。</td>
    <td>例如，企业宜搭应用的表单实例列表如下图，调用本接口批量更新四个表单内报销项目组件值。将报销项目的值修改为更新报销项目。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650531256950-7338b2a4-68a2-452d-b40c-5b8adfb136dd.png)<br />表单原始数据<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650531291214-d328b740-4bfc-4a07-b00e-b628e6b2356d.png)<br />成功调用后表单数据</td>
    <td rowSpan={2}><ol><li>如果选择不执行业务规则，那么 同步/异步 单次批量创建表单实例允许的数量是 **500**条。</li><li>如果选择执行业务规则</li></ol><br /><ol /></td>
  </tr>

  <tr>
    <td>[通过表单实例数据批量更新表单实例](https://open.dingtalk.com/document/orgapp-server/update-multiple-form-instances-with-the-form-instance-data)</td>
    <td>根据宜搭表单组件数据，批量更新表单实例信息。</td>
    <td>例如，企业宜搭应用的数据管理列表如图所示，四个宜搭表单实例都使用了报销项目组件，调用本接口可通过更新报销项目组件内的值，实现更新这四个宜搭表单。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650531478534-aad6e458-a208-48f8-afa4-b68c850cdbe5.png)<br />表单原始数据<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650531504384-5a73b314-5c32-410b-8e89-346aceae54d7.png)<br />成功调用后表单数据</td>
  </tr>

  <tr>
    <td>[批量获取表单实例数据](https://open.dingtalk.com/document/orgapp-server/obtain-multiple-form-instance-data)</td>
    <td>用于批量获取表单实例详情信息，包括实例名称、实例提交人等信息。</td>
    <td>例如，企业宜搭应用数据管理中的宜搭实例列表如下截图，调用本接口，根据实例Id批量查询列表内实例的详情信息。<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650531994266-95241e49-a1d0-459b-a394-e01b317d6765.png)</td>

    <td />
  </tr>

  <tr>
    <td rowSpan={2}>**组件**</td>
    <td>[保存表单数据](https://open.dingtalk.com/document/orgapp-server/save-form-data)（单个创建）</td>
    <td>调用本接口新增一条无审批流程的宜搭表单实例。</td>
    <td>![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650532196387-e017e188-97c8-4eff-8bc4-ff47e974ce19.png)</td>

    <td />
  </tr>

  <tr>
    <td>批量创建同[批量创建表单实例](https://open.dingtalk.com/document/orgapp-server/create-multiple-form-instances)</td>
    <td>--</td>
    <td>--</td>
    <td>--</td>
  </tr>

  <tr>
    <td rowSpan={3}>**其他**</td>
    <td>宜搭平台自调用接口不稳定</td>
    <td>解决：searchFieldJson.json偶发性地长时间查不出数据, 尤其是添加了loading之后更为明显(刷新之后即可)问题</td>
    <td>解决方案：用户可使用   /dingtalk/web/APP\_PR185LWG5XWYCPITZ58C/query/formProcInstData/getInstanceDatasLight.json   可设定每次查询时的子表数据量大小。</td>
    <td>--</td>
  </tr>

  <tr>
    <td>下架以下接口<br />![](https://yida-support.oss-cn-shanghai.aliyuncs.com/static/png/1650532761610-727d3119-14f0-428c-baff-c80a0397fcad.png)</td>
    <td>--</td>
    <td>--</td>
    <td>--</td>
  </tr>

  <tr>
    <td>对接口分类进行重新归纳整理：<br /><ul><li>“任务”分类下的部分接口调整到“表单/流程”分类下。</li></ul></td>
    <td>--</td>
    <td>--</td>
    <td>--</td>
  </tr>
</table>