API保存弹性域和多选基础资料,就这么简单!
在调用API接口时,你是否对弹性域和多选基础资料等特殊字段的保存无从下手?
单据中复杂类型的弹性域组合,怎样才可以方便快速地通过接口进行保存?
业务对象里的多选基础资料字段,又应该如何构造它的请求体参数?
现在,告诉你一个好消息,有了新版API(V2)的参数示例和在线测试,只需两步就能快速了解入参格式,并且支持实时调试接口。
接下来,小编为你详细解密!
1 适用版本
该功能适用版本为金蝶云·苍穹V5.0.002及以上。
2 特性展示
开放平台可通过零代码配置对外发布操作API,并自动构建数字、日期、文本、基础资料、下拉列表、弹性域、多选基础资料等类型字段的入参格式。
新版API(V2)优化了保存接口中参数示例和解析框架,参数更加扁平化,开发者维护请求参数后,在API参数示例、在线测试、API文档中均可看到参数示例。结合实际场景替换参数值,即可快速构造参数调用接口。
接下来为大家展示具体的接口示例。
01 保存凭证-弹性域应用
在金蝶云·苍穹表单中,弹性域是一种比较特殊的字段,主要用于总账凭证中的核算维度,配合主基础资料字段,将多个维度(基础资料、辅助资料、手工输入)的值组合在一起。
步骤一:创建API接口
以系统中的业务对象凭证为例,录入API基本信息及请求参数,其中字段“核算维度”为弹性域字段,通过点击按钮“添加属性”,可定义接口请求入参。
创建“保存凭证”API接口
点击请求参数上的“参数示例”,可以看到请求参数的示例数据。
参数示例界面
无需定义操作API的返回参数,确认入参字段后,点击“保存”按钮,即可完成接口创建。
注:目前弹性域字段中的维度暂时按名称(name)作为参数标识,后续会同时支持按编码(number)作为参数标识,敬请期待。
步骤二:在线调试
点击“API测试”按钮,进入在线调试界面,根据用户实际核算维度进行调整。此处以入参会计科目的核算维度为供应商(基础资料)和手工输入维度(其他类型)为例,如下图所示:
在线调试示例
接口执行成功后自动生成凭证,如下图所示:
自动生成凭证
注:若用户能确认具体的核算维度id,则以上信息均无需传入,系统直接按核算维度id保存,接口入参简约,执行时效率更高。
02 保存高等院校-多选基础资料字段应用
在金蝶云苍穹表单中,多选基础资料字段,用来选择并录入基础资料数据,可以同时选择多个资料放在一个字段中。此处,小编通过高等院校中的院校特性字段,教大家如何通过接口保存多选基础资料。
步骤一:创建API接口
以系统中的业务对象:高等院校为例,录入API基本信息及请求参数,其中字段“院校特性”为多选基础资料,通过点击按钮“添加属性”,可定义多选基础资料的入参:如id、number、name等,一般情况下建议只勾选1个参数即可,推荐使用id或number。
创建“保存高等院校”API接口
点击请求参数上的“参数示例”,可以看到请求参数的示例数据。
参数示例界面
确认入参字段后,点击“保存”按钮,接口创建完成。
步骤二:在线调试
点击“API测试”按钮,进入在线测试界面。当多选基础资料的入参同时勾选了id、number和name时,系统执行保存的优先级是id > number > name。
在线调试示例
接口执行后,高等院校保存成功。
接口执行成功
5 亮点价值
优化用户体验,降低API开发门槛
根据元数据自动生成各种字段的入参格式,开发者只需调整对应的参数值,即可快速进行接口调用,提升开发和系统集成效率。
6 相关链接
7 划重点
金蝶云·苍穹V5.0新版API(V2)提供参数示例和在线测试功能,实现入参格式的快速获取,并支持实时调试接口。具体特性如下:
开放平台操作API,自动构建请求入参,轻松搞定所有字段类型;
保存弹性域和多选基础资料时,可结合实际场景构造入参,方式灵活;
开放平台支持API在线测试,随时调试请求参数。
#往期推荐#
更多精彩内容,“码”上了解!↓
API保存弹性域和多选基础资料,就这么简单!
本文2024-09-23 00:27:30发表“云苍穹知识”栏目。
本文链接:https://wenku.my7c.com/article/kingdee-cangqiong-139585.html