1 接口介绍

保存操作API是通过在系统中维护接口基本信息、配置请求参数来定义接口具体的功能。

2 注意事项

• 保存操作接口根据入参的不同，可同时执行保存、更新、批量保存和批量更新四种操作。

• 候选键作为接口执行更新逻辑的唯一主键，需要谨慎选择，一般选id或number/billno为候选键，也可选择不同字段组合作为候选键。

• 若接口只用于更新数据，此时可以将候选键字段设为必填。

3 接口示例

3.1 维护API基本信息

录入API编码、API名称、业务对象、操作方式、详细描述等信息，请求方式为“POST”，系统自动生成API请求地址。

3.2 维护请求头参数

系统已预置Content-Type、accesstoken等参数，用户无需维护。

3.3 维护请求体参数

点击“添加属性”按钮快速添加请求参数，业务对象每个层级必须设有候选键，若在系统中查到相同候选键的数据，会执行更新操作，若未传入则执行新增操作。用户还可以点击“参数示例”按钮，查看JSON、XML、SOAP1.1、SOAP1.2 四种格式的数据示例。

3.4 维护操作参数（可选）

系统预设保存参数，用户可在保存时对数据进行特殊处理。

• importType ：保存类型，new - 新增，override - 覆盖，overridenew - 覆盖新增，接口默认执行覆盖新增逻辑；

• firePropChanged ：更新时触发值更新事件，true - 触发，false - 不触发，接口默认不触发；

• forcedSubmit：保存是否自动提交（注意，若单据的save插件中有复杂计算逻辑，配置后无法触发），submit - 提交，空 - 不提交，接口默认不自动提交；

• OverrideEntry ：更新时完整覆盖分录，会将原表单分录数据清除后追加分录， true - 覆盖，false - 不覆盖，接口默认不覆盖；

• mutex_ignoremodify：保存时忽略网络互斥，true - 忽略，false - 不忽略，接口默认不忽略；

• is_importinit：是否触发引入方法，true - 触发，false - 不触发，接口默认触发。

3.5 定义返回参数

保存操作服务的返回参数目前不允许用户自定义，统一按平台规范返回。

 API Response契约统一为:

   {

       “data”: {                                  //结果数据

            "result": [],                          //返回结果详细信息

　         “failcount”: “”,                   //操作失败数量

　         “successcount”: “”             //操作成功数量

        }

       “errorCode”: “”,                     //错误码
       “message”: null,                     //失败时的提示信息

       “status”: true/false                //是否成功

   }

3.6 API测试

点击“API测试”按钮，开始调试API。当传入候选键字段时，执行更新操作，不传入候选键字段，则执行新增操作。

4 更多资讯

关于OpenAPI的更多资讯，请随时关注新特性公告。