预算体系-数据集查询接口

栏目：云星瀚知识作者：金蝶来源：金蝶云社区发布：2024-09-22浏览：1

预算体系-数据集查询接口

1 简要描述：

数据集查询接口、按数据集查询维度接口、按数据集查询维度成员接口

1.1数据集查询接口

接口定义： kd.epm.eb.service.openapi.impl.DataSetServicelmpl#query

请求方式：

微服务

请求参数：

参数名	必录	类型	描述
modelNumber	是	文本	体系编码

返回参数：

参数名	类型	描述
Number	文本	编码
Name	文本	名称

微服务请求示例：

Map < String , Object > map = new HashMap <>(16);

map . put (" modelNumber ","OLP0611");

DispatchServiceHelper . invokeBizService (" epm "," eb "," DataSetService "," query ", map );

1.2 维度查询接口

接口定义： kd.epm.eb.service.openapi.impl.DataSetServicelmpl#query

请求方式：

微服务

请求参数：

参数名	必录	类型	描述
modelNumber	是	文本	体系编码
DatasetNumber	是	文本	数据集编码

返回参数：

参数名	类型	描述
Number	文本	编码
Name	文本	名称
ID	数值	ID
ShortNumber	文本	维度简码
modelNumber	文本	实体标识

微服务请求示例：

Map < String , Object > map = new HashMap <>(16);

map . put (" modelNumber ","OLP0611");

map . put (" datasetNumber "," decompose ");

DispatchServiceHelper . invokeBizService (" epm "," eb "," DimensionService "," query ", map );

1.3 根据数据集查询维度成员

接口定义： kd.epm.eb.service.openapi.impl.MemberQuerylmpl#queryByDataset

请求方式：

微服务

请求参数：

参数名	必录	类型	描述
modelNumber	是	string	体系编码
dimNumber	是	string	维度编码
datasetNumber	是	string	数据集编码
menberNumber	否	string	维度成员为空时，取一级成员，如果有成员权限，则过滤成员权限
range	否	string	维度成员范围，默认只取本身

返回参数：

参数名	类型	描述
Number	文本	编码
Name	文本	名称
isLeaf	布尔	是否明细

微服务请求示例：

Map < String , Object > map = new HashMap <>(16);

map . put (" modelNumber ","OLP0611");

map . put (" datasetNumber "," decompose ");

map . put (" dimNumber "," Entity ");

map . put (" memberNumber ","001");/／第一次加载时不传此参数，可获取根节点下有权限的成员，含断层的间接下级

map . put (" range ",40);

DispatchServiceHelper . invokeBizService (" epm "," eb "," MemberService ",

" queryByDataset ", map );

1.4 根据数据集批量查询维度成员

接口定义： kd.epm.eb.service.openapi.impl.MemberQuerylmpl#batchQueryByDataset

请求方式：

微服务

参数：

参数名	必录	类型	描述
modelNumber	是	string	体系编码
datasetNumber	是	string	数据集编码，非费用必填
menbers	是	List<map<string,string>>	map内容如下参见下表
isCheckMain	否	string	是否检查主维度（非自定义维度）全部输入，默认为否(0),需要检查传入1
isShortNumbwe	否	string	默认为0，如果为1，维度编码为简码
isToMainMessage	否	string	默认为1，每行查询有信息是否同步到主信息中去，此时如果isCheckMain=1时，某个主维度没有找到成员，也会message。

member参数内容：

参数名	必选	类型	说明
dimNumber	是	string	维度编码
memberNumber	是	string	维度成员为空时，取一级成员，如果有成员权限，则过滤成员权限
range	否	string	维度成员范围，默认仅自己
level	否	string	实际传入整型，只有指定下级范围才会使用它

range参数内容：

参数值	说明
10	仅自己
20	直接下级_不含自己
30	直接自己_含自己
40	所有下级_不含自己
50	所有下级-含自己
60	所有平级_不含自己
70	所有平级_含自己
90	所有下级_仅明细成员
100	所有下级_仅明细成员_含自己
110	所有下级_仅非明细成员
150	所有父_含自己
160	所有父_不含自己
170	指定下级_含自己，需要传入level参数
180	指定下级_不含自己，需要传入level参数

返回参数：

参数名	类型	描述
result	list<liet<map<string,object>>>	返回的数据结果，包含的维度成员，按照传入的参数的顺序输出结果，一行参数会有多个结果，某行参数错误不会影响其他行的查询。
message	文本	如果传的维度缺少必选维度或者维度不存在，必要参数为空，则给提示信息。

result 中 Map内容

参数名	类型	描述
dimNumber	文本	维度编码，如果传入参数为简码则输出简码
message	文本	如果未取到成员，输出消息，表中下面的内容不会输出
number	文本	编码
name	文本	名称
isLeaf	布尔	是否明细

异常信息（message）

异常信息	说明
参数**为空	必要参数未输入
编码为**的体系不存在	modelNumber传入的体系不存在
编码为**的数据集不存在	全面预算体系需要传入数据集而未传入
编码为**的维度不存在	dimNumber对应的维度不存在
编码为**的维度再数据集中不存在	维度虽然存在，但当前数据集中不存在
编码为**的维度为必要维度，此次查询未包含	isCheckMain=1时的检查信息，不影响后面的查询成员
编码为**的维度成员不存在	未查询到memberNumber对应的成员
编码为**的维度成员不属于当前数据集	科目维度区分不同的数据集，成员虽然存在，但不属于当前数据集
参数不符合	range不在指定列表内或者level不能转为整型
编码为**的维度为必要，此次查询未查询到成员	isCheckMain=1时，某个必要维度上完全没查询到成员

微服务请求示例：

Map < String , Object > map = new HashMap <>(16);

map . put (" modelNumber ","OLP0611");

map . put (" dataset Number "," decompose ");

List < Map < String , String >> members = new ArrayList <>(16);

map . put (" members "," members ");

Map < String , String > member = new HashMap <>(4);

members . add ( member );

member . put (" dimNumber "," Entity ");

member . put (" isShortNumber ","1");

member . put (" memberNumber ","Org1");

member . put (" range ", kd . epm . eb . common . enums . RangeEnum . ONLY . getIndStr ());

//...这里传入其他维度成员信息

member = new HashMap <>(4);

members . add ( member );

DispatchServiceHelper . invokeBizService (" epm "," eb "," MemberService ","

" batchQueryByDataset ", map );

变更记录

产品版本	更新内容	更新日期
V6.0.1	初始版本	2023年10月28日
V6.0.4	优化了预算体系查询接口，适用于批量查询维度成员的场景，丰富了接口的适用范围，满足用户批量查询需要	2023年12月