全面预算——数据接口

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

全面预算——数据接口

变更记录

产品版本	更新内容	更新日期
V5.0.0	初始版本	2022年12月1日
V5.0.023	入参变化	2023年07月18日

1、预算数据查询接口

描述：按传入的用户编码、体系编码、数据集编码、维度编码、维度成员编码进行数据查询。

接口定义：

kd.epm.eb.service.olap.ShrekService.queryData(Map<String, Object> params);

接口实现：

kd.epm.eb.service.openapi.data.ShrekServiceImpl

接口地址：http://localhost:8080/ierp/kapi/v2/bgmd/shrek/query

请求方式：微服务及OpenAPI

请求参数：

参数名	必录	类型	描述
modelNumber	是	文本	体系编码
datasetNumber	是	文本	数据集编码
data	是	Map	查询维度编码及维度成员编码数据集合，集合的Key是维度编码，集合的Value是维度成员编码集合

返回数据：

[
          ["Entity", "Account", "BudgetPeriod"], //维度编码
          [100, "Org1", "1001", "FY2022.01M"], // 数组的第一个是度量值，后面的是维度成员编
码，顺序是按维度编码的顺序返回
          [200, "Org1", "1002", "FY2022.02M"],
          [300, "Org2", "1003", "FY2022.03M"],
          [400, "Org2", "1004", "FY2022.04M"]
]

微服务请求示例：

Map<String, Object> params = new HashMap();
params.put("modelNumber", "体系编码");
params.put("datasetNumber", "体系下数据集编码");

Map<String, Object> dimMemberMap = new HashMap();
dimMemberMap.put("Entity", Arrays.asList("Entity", "Org1"));
dimMemberMap.put("Account", Arrays.asList("1001", "1002"));
dimMemberMap.put("BudgetPeriod", Arrays.asList"FY2022", "FY2022.01M"));
dimMemberMap.put("Version", Arrays.asList"Version", "Actual"));
params.put("data", dimMemberMap);

DispatchServiceHelper.invokeBizService("epm", "eb", "ShrekService", "queryData",
new Object[]{params});

OpenAPI请求示例：

{
      "params": {
            "modelNumber": "budget",
            "datasetNumber": "default",
            "data": {
                    "Entity": ["Entity",
                    "Org1",
                    "org2"],
                    "Account": ["1001",
                    "1002"],
                    "BudgetPeriod": ["FY2022",
                    "FY2022.01M"],
                    "Version": ["Version",
                    "Actual"]
            }
      }
}

重要提示：为了保证接口的性能，当前数据查询接口只返回2万条数据。

2、预算数据写入接口

接口定义：

kd.epm.eb.service.olap.ShrekService.saveData(Map<String, Object> params)
kd.epm.eb.service.olap.ShrekService.saveIncrementData(Map<String, Object>
params)

接口实现：

kd.epm.eb.service.openapi.data.ShrekServiceImpl

接口地址：http://localhost:8080/ierp/kapi/v2/bgmd/shrek/save

请求方式：微服务及OpenAPI

请求参数：

参数名	必录	类型	描述
modelNumber	是	文本	体系编码
datasetNumber	是	文本	数据集编码
dimensions	是	数组	数据写入的维度编码集合，用来确认数据的维度顺序，这里的维度编码数量必须与数据集关联的维度数量保持一致
data	是	数组集合	需要保存的数据
increment	否	文本	"true" 或者 "false"，数据保存是否是自增计算，默认是不自增

返回数据：

无，默认成功无返回，如果参数不正确则会抛出异常（微服务）或者返回不成功信息（OpenAPI）。

微服务请求示例：

Map<String, Object> params = new HashMap();
params.put("modelNumber", "写入数据的体系编码");
params.put("datasetNumber", "写入数据的体系下数据集编码");
params.put("dimensions", new String[] { "Entity", "Account", "BudgetPeriod",
"Version"});

List<Object[]> memberData = new ArrayList();
memberData.add(new Object[] {100, "Org1", "1001", "FY2022.01M", "V_None"});
memberData.add(new Object[] {200, "Org1", "1002", "FY2022.02M", "V_None"});
memberData.add(new Object[] {300, "Org2", "1003", "FY2022.03M", "V_None"});
memberData.add(new Object[] {400, "Org2", "1004", "FY2022.04M", "V_None"});
params.put("data", memberData);

DispatchServiceHelper.invokeBizService("epm", "eb", "ShrekService", "saveData",
new Object[]{params});
// 自增接口
DispatchServiceHelper.invokeBizService("epm", "eb", "ShrekService",
"saveIncrementData", new Object[]{params});

OpenAPI请求示例：

{
      "params": {
            "modelNumber" : "budget", // 体系编码
            "datasetNumber" : "default", // 数据集编码
            "dimensions" : ["Entity", "Account", "BudgetPeriod", "Version"], //维度编码
            "data" : [
                  [100, "org1", "1001", "FY2022Y.M01", "V_None"], // 数据维度成员的顺序对应上面维度编码传入的顺序
                  [200, "org2", "1001", "FY2022Y.M02", "V_None"],
                  [300, "org3", "1001", "FY2022Y.M03", "Actual"]
            ],
            "increment" : "false" // 是否是自增算计，不是必录项
      }
}