WebApi简单说明和字段格式介绍原创
金蝶云社区-eris
eris
11人赞赏了该文章 1.4万次浏览 未经作者许可,禁止转载编辑于2022年11月15日 10:08:28
summary-icon摘要由AI智能服务提供

本文介绍了在数据传输和接口使用中需注意的要点,包括数据的顺序和字段格式的重要性,不同字段类型的具体格式规范,如基础资料、多选基础资料、大文本、弹性域等,并详细说明了K/3Cloud系统的WebAPI接口数量及功能,包括在线测试功能的使用和系统集成资源的分享。

一、传递的数据简单说明: 

1. 顺序很重要,得按在线参考的顺序来填写,故在组织数据时不要用HashSet这样的不能确定顺序的集合类。

2. 字段格式很重要,得按在线参考中的格式填写。                                            

3. 允许引入(功能控制属性中)的字段,才会在线参考数据包中显示,但不影响字段实际同步。

4. 基础资料类型的字段,可以使用内码和字段属性中配置的关联检索字段同步数据,但像创建人,审核人是没关联检索字段属性的,故只能使用内码同步

5. 关联检索字段一般为基础资料的编码,但也有使用名称的 , 编码标识一般为FNumber ,但也有特别的,比如员工编码为FStaffNumber

6. 内码标识一般为FId, 但也有像组织内码为FOrgId,物料内码为FMaterialId的特殊情况  


二、字段格式:

1. 一般字段格式:\"FieldKey\":\FieldValue\"

2. 基础资料,组织,多类别基础资料,批号,基础资料文本字段等格式:\"BaseDataKey\":{\"FNumber\":\"\"}

    注释:2.1多类别基础资料一定要有相关的多类别基础资料列表;多类别基础资料列表的格式:key:"基础资料FormId";     2.2   FNumber是基础资料的编码,不一定都是FNumber,比如员工可能是FStaffNumber;

3. 多选基础资料:\"FMulBaseKey\":[ {\"FStaffNumber\":\"\"},{\"FStaffNumber\":\"\"},...]

   注释:可以看成是基础资料的集合;

4. 大文本格式:\"FLargeTextKey\":\"\",\"FLargeText_Tag\":\"\"

   注释:包含文本和标题

5. 弹性域字段,包括核算维度,仓位,辅助属性,职务等级等,

格式1:按内码,key:value, 比如 "FFlex1":100007

格式1:按维度,不同维度格式不一样,具体有维度类型决定,比如 "FFlex1":{"FFLEX1__FF100001":{"FNumber":"America"},"FFLEX1__FF100002":{"FNumber":"JHFS02_SYS"},"FFLEX1__FF100003":"string"}

6.子单据头格式:\"FSubHeadEntityKey\":{\"FieldKey\":\FieldValue\",\"BaseDataKey\":{\"FNumber\":\"\"},...}

 注释:子单据头跟单据头的对应关系是一对一的关系;

7. 单据体格式:"FEntityKey\":[{\"FieldKey\":\FieldValue\",\"BaseDataKey\":{\"FNumber\":\"\"},...},{\"FieldKey\":\FieldValue\",\"BaseDataKey\":{\"FNumber\":\"\"},...},...]

   注释:单据体跟单据头的对应关系是一对多的关系;

8. 子单据体格式:"FEntityKey\":[{\"FieldKey\":\FieldValue\",\"FSubEntityKey\"::[{\"FieldKey\":\"0\",\"FText2\":\"\",...}],...},...]

9.业务流程字段格式:"FBFLowId":{"FId":"FIDValue"}, FID到t_BF_DefVersion中查询, 但增加业务流程字段一般要把关联实体先赋值上, "FEntity_Link": [

                   {

                       "FEntity_Link_FFlowId": "0b064121-4926-4808-8632-a195b6a202e8",

                       "FEntity_Link_FFlowLineId": "14",

                       "FEntity_Link_FRuleId": "SUB_PPBOM_Pick",

                       "FEntity_Link_FSTableName": "T_SUB_PPBOMENTRY",

                       "FEntity_Link_FSBillId": "100006",

                       "FEntity_Link_FSId": "100007"

                   },

FEntity_Link_FFlowLineId 在t_BF_DefVersion中的FKernelxml中可以查询到。

10. 多类别基础资料字段,在2017年4月份版本之前是不支持多分录赋值的。

11.多语言字段:\"FKey\":[{\"Key\":1033,\"Value\":\"英文\"},{\"Key\":2052,\"Value\":\"中文\"},{\"Key\":3076,\"Value\":\"繁体\"},{\"Key\":1034,\"Value\":\"西语\"}]

12.枚举字段:格式:"枚举字段Key":"枚举字段值",备注: 不支持传枚举字段名称同步

13. 创建人:"FCreatorId":{"FUserId":"用户内码"}, 用户只能用内码检索

14. 采购申请单申请人:

1. 格式:"FApplicantId":{"FNumber":"员工编码"}

2. 此字段在NeedReturnFileds中并不会返回


三、接口说明:

1、 由于整个K/3Cloud是后端是动态领域建模,没有实际的单据模型,只有元模型,所以WebAPI接口数量非常少,到目前为止也9个操作接口和3个通用接口。具体说明和测试可以参考WebAPI页面在线说明和测试。

在线测试:

2、从2016年11月补丁开始,WebAPI上线了在线测试功能。

1)位置:WebAPI页面,参数说明区域的左上方。

2)连接测试:主要是为了验证登陆参数,用户仅需要填写用户密码,其他参数自动获取并显示在窗口。

3)接口测试:支持WebAPI目前所有支持的接口,并根据所选的单据显示当前单据所支持的接口。

4)最犀利功能: 保存和暂存时可以在线填写单据页面数据并返回到测试窗口测试,省去了用户构造数据的麻烦。


四、系统集成各种分享:

https://vip.kingdee.com/article/20812