单据查询 参数详细说明原创
7人赞赏了该文章
2,021次浏览
编辑于2022年05月09日 10:19:45
摘要由AI智能服务提供
本文本描述了一个请求参数的详细说明,包括JSON格式数据的要求和字段如FormId、FieldKeys、FilterString等的定义。同时,也说明了返回结果的数据格式和示例,并提供了代码示例说明如何调用Web API来执行查询操作。还详细解释了FilterString的组成及错误代码的含义。最后,展示了请示参数和响应数据的示例,以及数据格式的转换。
{ "FormId": "BD_PaymentCondition",//业务对象表单Id(必录) "FieldKeys": "FID,FNumber,FName,FDescription",//需查询的字段key集合,字符串类型,格式:"key1,key2,..."(必录) 注(查询单据体内码,需加单据体Key和下划线,如:FEntryKey_FEntryId); 取基础资料内码 FCreateOrgId.FNumber "FilterString": " ( FDOCUMENTSTATUS='C' and FFORBIDSTATUS='A' and FUSEORGID=FCreateOrgId and (FMODIFYDATE>=to_date('2021/1/1 0:00:00','yyyy-mm-dd hh24:mi:ss') and FMODIFYDATE<=to_date('2022-05-09 10:03:08','yyyy-mm-dd hh24:mi:ss') ) )",//过滤条件 "OrderString": "",排序字段 //"TopRowCount": 10,//取前多少条数据,类似数据库的TOP功能 "StartRow": 0,//从哪一行开始取数据 "Limit": 12,//实际为每页取多少条数据 "SubSystemId": ""//表单所在的子系统内码 }
一、请求参数说明: 1.data:JSON格式数据(详情参考JSON格式数据)(必录) 1.1.FormId:业务对象表单Id(必录) 1.2.FieldKeys:需查询的字段key集合,字符串类型,格式:"key1,key2,..."(必录) 注(查询单据体内码,需加单据体Key和下划线,如:FEntryKey_FEntryId) 1.3.FilterString:过滤条件,数组类型,如:[{"Left":"(","FieldName":"Field1","Compare":"=","Value":"111","Right":")","Logic":"AND"},{"Left":"(","FieldName":"Field2","Compare":"=","Value":"222","Right":")","Logic":""}] 1.4.OrderString:排序字段,字符串类型(非必录) 1.5.TopRowCount:返回总行数,整型(非必录) 1.6.StartRow:开始行索引,整型(非必录) 1.7.Limit:最大行数,整型,不能超过2000(非必录) 1.8.SubSystemId:表单所在的子系统内码,字符串类型(非必录)
二、返回结果: [["FValue1","FValue2",...],["FValue1","FValue2",...],...] [ [ 102256450, "FKTJ037", "预付65%,验收合格后付余款", "预付65%,入库后付余款" ], [ 102497357, "FKTJ69", "预付30%,第一阶段验收付30%;第二阶段验收付20%;第三阶段验收付20%", "预付30%,第一阶段验收30%;第二阶段验收付20%;第三阶段验收付20%" ] ]
三、代码示例: // 使用webapi引用组件Kingdee.BOS.WebApi.Client.dll K3CloudApiClient client = new K3CloudApiClient("http://localhost:1200/"); var loginResult = client.ValidateLogin("61d94a911eae96","Administrator","888888",2052); var resultType = JObject.Parse(loginResult)["LoginResultType"].Value<int>(); //登录结果类型等于1,代表登录成功 if (resultType == 1) { client.ExecuteBillQuery("{"FormId":"","FieldKeys":"","FilterString":[],"OrderString":"","TopRowCount":0,"StartRow":0,"Limit":0,"SubSystemId":""}"); } 四、JSON格式数据: { "FormId": "", "FieldKeys": "", "FilterString": [], "OrderString": "", "TopRowCount": 0, "StartRow": 0, "Limit": 0, "SubSystemId": "" } 五、参数FilterString说明: 1、Left:左括号 2、FieldName:字段名 3、Compare:比较运算符,如 大于">"、小于"<"、等于"="、包含"like"、左包含"llike"、右包含"rlike" 4、Value:比较值 5、Right:右括号 6、Logic:逻辑运算符,如 "and"、"or" 备注:错误代码MsgCode说明 0:默认 1:上下文丢失 2:没有权限 3:操作标识为空 4:异常 5:单据标识为空 6:数据库操作失败 7:许可错误 8:参数错误 9:指定字段/值不存在 10:未找到对应数据 11:验证失败 12:不可操作 13:网控冲突
调用示例: 1.请示参数 { "formid": "BD_PaymentCondition", "time": "2021-01-01 00:00:00", "pagesize": 2, "pageindex": 0 } 2.响应数据 { "rtnCode": "S", "rtnMsg": "", "rtnTotalRecord": "14", "rtnData": [ { "sourceId": "102256450", "mdmCode": "FKTJ037", "mdmName": "预付65%,验收合格后付余款", "describe": "预付65%,入库后付余款" }, { "sourceId": "102497357", "mdmCode": "FKTJ69", "mdmName": "预付30%,第一阶段验收付30%;第二阶段验收付20%;第三阶段验收付20%", "describe": "预付30%,第一阶段验收30%;第二阶段验收付20%;第三阶段验收付20%" } ] }
推荐阅读