参数开放接口

栏目：云苍穹知识作者：金蝶来源：金蝶云社区发布：2024-09-23浏览：3

参数开放接口

参数相关接口都在kd.bos.servicehelper.parameter.SystemParamServiceHelper类里

1.接口列表

接口名	说明
saveAppParameter	保存与更新应用参数
getCloudParameter	获取云参数
getAppParameter	获取应用参数
getSystemParameter	获取系统参数
getParameters	获取整单系统参数
getParameter	获取某个系统参数
getPublicParameter	获取公共参数
getBillTypeParameter	获取单据类型参数
getBillParameter	获取单据参数
getGroupControlFields	获取参数表单中的集团控制字段
loadAppParameterFromCache	从缓存中获取某个应用参数
loadBatchAppParameterByOrg	从数据库中获取批量应用参数
loadBatchAppParameterByOrgFromCache	从缓存中获取批量应用参数
loadBillParameterFromCache	获取单据参数（缓存），返回BillParam
loadBillParameterObjectFromCache	获取单据参数（缓存），返回Map<String, Object>
loadPublicParameterFromCache	从缓存中获取某个公共参数
loadPublicParametersFromCache	从缓存中获取所有公共参数
getShowContentParameter	获取公共参数--显示内容

2.接口详情

2.1 saveAppParameter

接口描述

保存与更新应用组织下的应用参数

方法

public static ParamOperationResult saveAppParameter(String viewType, Long orgId, Long actBookId, String appId,Map<String, Object> params)

参数说明

参数	类型	说明
viewType	String	职能类型，默认为15业务单元
orgId	Long	组织id
actBookId	Long	账簿id，默认为0
appId	String	应用id
params	Map<String, Object>	参数值，key为参数字段的key， Object为参数的值

返回值

返回一个ParamOperationResult对象。

具体ParamOperationResult对象描述参考文档最下方的【返回对象描述】。

示例代码

保存或更新应用id为1，职能类型为15，组织id为10000，账套id为0的系统参数params，返回保存或更新的结果。

ParamOperationResult result = SystemParamServiceHelper. saveAppParameter(“15”, 10000, 0, 1, params);

2.2 getCloudParameter

接口描述

获取云应用参数中的某一参数

方法

public static Object getCloudParameter(String cloudId, String key)

参数说明

参数	类型	说明
cloudId	String	云id
key	String	参数key,也就是参数的标识

返回值

返回云应用参数中的某一参数

示例代码

从数据库中获取云id为1，参数标识为ap_001的云应用参数。

Object cloudParamObj = SystemParamServiceHelper. getCloudParameter(1, “ap_001”);

2.3 loadAppParameterFromCache

接口描述

从缓存中获取应用参数

方法

public static Object loadAppParameterFromCache(AppParam appParam, String key)

public static Map<String, Object> loadAppParameterFromCache(AppParam appParam)

参数说明

参数

类型

说明

appParam

AppParam

包含：

{

appId: String,

viewType: String,

orgId: Long,

actBookId: Long

}

应用参数对象

其中，

appId为应用id，

viewType为职能类型，

orgId为组织id，

actBookId为账簿id

key

String

参数key

返回值

返回应用参数

示例代码

从缓存中获取key值为ap_001的系统参数

Object appParamObj = SystemParamServiceHelper.loadAppParameterFromCache (appParam, “ap_001”);

从缓存中批量获取系统参数

Map<String, Object> appParamObj = SystemParamServiceHelper.loadAppParameterFromCache (appParam);

2.4 loadBatchAppParameterByOrg

接口描述

从数据库中根据组织id列表，获取应用参数

方法

public static Map<String, Map<String, Object>> loadBatchAppParameterByOrg(AppParam appParam, List<Long> orgIds)

参数说明

参数

类型

说明

appParam

AppParam

包含：

{

appId: String,

viewType: String,

orgId: Long,

actBookId: Long

}

应用参数对象

其中，

appId为应用id，

viewType为职能类型，

orgId为组织id，

actBookId为账簿id

orgIds

List<Long>

组织id列表

返回值

返回应用参数包

示例代码

从数据库中根据组织id列表，获取批量应用参数。返回对象中，以组织id为Map的key，对应的Value就是该组织下的系统参数

Map<String, Map<String, Object>> appParam = SystemParamServiceHelper. loadBatchAppParameterByOrg (appParam, orgIds);

2.5 loadBatchAppParameterByOrgFromCache

接口描述

从缓存中批量获取应用参数

方法

public static Map<String, Map<String, Object>> loadBatchAppParameterByOrgFromCache(AppParam appParam, List<Long> orgIds)

参数说明

参数

类型

说明

appParam

AppParam

包含：

{

appId: String,

viewType: String,

orgId: Long,

actBookId: Long

}

应用参数对象

其中，

appId为应用id，

viewType为职能类型，

orgId为组织id，

actBookId为账簿id

orgIds

List<Long>

组织id列表

返回值

返回应用参数包

示例代码

从缓存中根据组织id列表，获取批量应用参数。返回对象中，以组织id为Map的key，对应的Value就是该组织下的系统参数

Map<String, Map<String, Object>> appParam = SystemParamServiceHelper. loadBatchAppParameterByOrgFromCache (appParam, orgIds);

2.6 getAppParameter

接口描述

获取应用参数

方法

public static Object getAppParameter(String appId, Long orgId, String key)

public static Object getAppParameter(String appId, String viewType, Long orgId, String key)

public static Object getAppParameter(String appId, String viewType, Long orgId, Long actBookId, String key)

参数说明

参数	类型	说明
appId	String	应用id
viewType	String	职能类型，默认15为业务单元
orgId	Long	组织id
actBookId	Long	账簿id，默认0
key	String	系统参数key

返回值

返回应用参数

示例代码

从数据库中查询应用id为1，职能类型为15，组织id为10000，账簿id为0，参数标识为ap_001的系统参数值

Object appParamObj = SystemParamServiceHelper. getAppParameter (“1”, “15”, 10000, 0L “ap_001”);

2.7 getSystemParameter

接口描述

获取系统参数

方法

public static Object getSystemParameter(String cloudId, String appId, Long orgId, String key)

public static Object getSystemParameter(String cloudId, String appId, String viewType, Long orgId, String key)

public static Object getSystemParameter(String cloudId, String appId, String viewType, Long orgId, Long actBookId, String key)

参数说明

参数	类型	说明
cloudId	String	云id
appId	String	应用id
viewType	String	职能类型，默认15为业务单元
orgId	Long	组织id
actBookId	Long	账簿id，默认0
key	String	系统参数key

返回值

返回系统参数

示例代码

从数据库中查询云id为空，应用id为1，职能类型为15，组织id为10000，账簿id为0，参数标识为ap_001的系统参数值

Object sysParamObj = SystemParamServiceHelper. getSystemParameter (“”, “1”, “15”, 10000, 0L “ap_001”);

2.8 getParameters

接口描述

获取整单系统参数

方法

public static DynamicObject getParameters(Long orgId, Long acctBookId, String subSystem)

public static DynamicObject getParameters(String viewType, Long orgId, Long acctBookId, String subSystem)

参数说明

参数	类型	说明
viewType	String	职能类型
orgId	Long	组织id
actBookId	Long	账簿id
subSystem	String	子系统

返回值

返回整单的系统参数

示例代码

从数据库中获取子系统为“application/fi/cas”，组织id为10000，职能类型为15，账簿id为0的系统参数。

Object sysParamObj = SystemParamServiceHelper. getParameters( “15”, 10000, 0L “application/fi/cas”);

2.9 getParameter

接口描述

获取某个系统参数值

方法

public static Object getParameter(String viewType, Long orgId, Long acctBookId, String subSystem, String key)

参数说明

参数	类型	说明
viewType	String	职能类型，默认15为业务单元
orgId	Long	组织id
actBookId	Long	账簿id，默认0
subSystem	String	子系统
key	String	系统参数key

返回值

返回某个系统参数值

示例代码

从数据库中获取子系统为“application/fi/cas”，组织id为10000，职能类型为15，账簿id为0，参数标识为ap_001的系统参数。

Object sysParamObj = SystemParamServiceHelper. getParameter( “15”, 10000, 0L “subSystem”, “ap_001”);

2.10 loadPublicParameterFromCache

接口描述

从缓存中获取公共参数

方法

public static Object loadPublicParameterFromCache(String key)

参数说明

参数	类型	说明
key	String	公共参数key

返回值

返回公共参数

示例代码

从缓存中获取参数标识为ap_001的公共参数。

Object publicParamObj = SystemParamServiceHelper. loadPublicParameterFromCache (“ap_001”);

2.11 loadPublicParametersFromCache

接口描述

从缓存中获取所有公共参数

方法

public static Map<String, Object> loadPublicParametersFromCache()

返回值

返回公共参数

示例代码

从缓存中获取所有公共参数。

Map<String, Object> publicParam = SystemParamServiceHelper. loadPublicParametersFromCache ();

2.12 getPublicParameter

接口描述

获取公共参数

方法

public static Object getPublicParameter(String key)

public static Map<String, Object> getPublicParameter(String... key)

public static DynamicObject getPublicParameter()

参数说明

参数	类型	说明
key	String	公共参数key

返回值

返回公共参数对象

示例代码

从数据库中获取参数标识为ap_001的公共参数

Object pubParamObj = SystemParamServiceHelper. getPublicParameter ( “ap_001”);

从数据库中获取所有公共参数

DynamicObject pubParamObj = SystemParamServiceHelper. getPublicParameter ();

2.13 loadBillParameterFromCache

接口描述

从缓存中获取单据参数

方法

public static BillParam loadBillParameterFromCache(String formId)

参数说明

参数	类型	说明
formId	String	表单id

返回值

返回单据参数

示例代码

从缓存中获取业务表单id为1的单据参数。

BillParam billParamObj = SystemParamServiceHelper. loadBillParameterFromCache ( “1”);

2.14 loadBillParameterObjectFromCache

接口描述

从缓存中获取单据参数

方法

public static Map<String, Object> loadBillParameterObjectFromCache(String formId)

参数说明

参数	类型	说明
formId	String	表单id

返回值

返回单据参数

示例代码

从缓存中获取业务表单id为1的单据参数。

Map<String, Object> billParamObj = SystemParamServiceHelper. loadBillParameterObjectFromCache ( “1”);

2.15 getBillParameter

接口描述

获取单据参数

方法

public static Object getBillParameter(String formId, String key)

参数说明

参数	类型	说明
formId	String	业务单据id
key	String	单据参数key

返回值

返回单据参数

示例代码

从数据库中获取业务表单id为1，参数key为ap_001的单据参数。

Object sysParamObj = SystemParamServiceHelper. getBillParameter (“10000”, “ap_001”);

2.16 getGroupControlFields

接口描述

获取系统参数表单中的集团管控字段

方法

public static List<String> getGroupControlFields(String formId)

参数说明

参数	类型	说明
formId	String	参数表单id

返回值

返回表单中的集团管控字段

示例代码

从数据库中获取参数表单id为1000的系统参数集团管控字段

List<String> sysParamObj = SystemParamServiceHelper. getGroupControlFields (“1000”);

2.17 getShowContentParameter

接口描述

从缓存中获取公共参数显示内容

方法

public static ShowContentParam getShowContentParameter()

返回值

返回公共参数--显示内容，对应公共参数，快捷显示下的显示内容（下拉列表）功能：描述是否打开云之家，是否互换小K，是否显示评论，是否应用评分，是否徐少春个人号，是否售前热线，是否售前在线咨询，是否提单反馈。具体参考【返回对象描述】

示例代码

ShowContentParam showContentParam = SystemParamServiceHelper. getShowContentParameter();

3.返回对象描述

对象类型

类型

描述

ParamOperationResult

{

message: String,

success:boolean

}

message：保存成功或错误的返回信息

success：保存/更新成功或失败的标识

ShowContentParam

{

openYzj:boolean, call1K:boolean,

comment:boolean,

robertNumber:boolean,

preSaleHotline:boolean,

preSaleOnlineConsultation:boolean,

billOfLadingFeedback:boolean,

}

openYzj: 是否打开云之家, call1K: 是否互换小K,

comment: 是否显示评论,

robertNumber: 是否徐少春个人号,

preSaleHotline: 是否售前热线,

preSaleOnlineConsultation: 是否售前在线咨询,

billOfLadingFeedback:boolea:是否提单反馈,

参数开放接口

点击下载文档

上一篇：云之家同步人员下一篇：集团管控整体介绍及使用

本文2024-09-23 00:31:01发表“云苍穹知识”栏目。
本文链接：https://wenku.my7c.com/article/kingdee-cangqiong-139968.html

参数开放接口

1.接口列表

2.接口详情

2.1 saveAppParameter

2.2 getCloudParameter

2.3 loadAppParameterFromCache

2.4 loadBatchAppParameterByOrg

2.5 loadBatchAppParameterByOrgFromCache

2.6 getAppParameter

2.7 getSystemParameter

2.8 getParameters

2.9 getParameter

2.10 loadPublicParameterFromCache

2.11 loadPublicParametersFromCache

2.12 getPublicParameter

2.13 loadBillParameterFromCache

2.14 loadBillParameterObjectFromCache

2.15 getBillParameter

2.16 getGroupControlFields

2.17 getShowContentParameter

3.返回对象描述

参数开放接口

管理会计—副产品核算不到成本

标准成本存货收发存汇总表和存货明细账数据不一致

【U8+】管理会计-分步分项结转-分项成本核算流程

【U8+】管理会计-成本管理-联副产品核算流程

【U8+】供应链-委外管理-委外总体-委外业务流程

【U8+】供应链-合同管理-合同期初录入

【U8+】供应链-质量管理-来料检验流程

成本管理-存货数据来源设置-计入直接材料和入库数量的出入库类别设置及作用

成本管理-期末处理自动生成的调整单计入成本

成本管理-系统出库调整单对照表的应用和设置

阅读排行

参数开放接口

1.接口列表

2.接口详情

2.1 saveAppParameter

2.2 getCloudParameter

2.3 loadAppParameterFromCache

2.4 loadBatchAppParameterByOrg

2.5 loadBatchAppParameterByOrgFromCache

2.6 getAppParameter

2.7 getSystemParameter

2.8 getParameters

2.9 getParameter

2.10 loadPublicParameterFromCache

2.11 loadPublicParametersFromCache

2.12 getPublicParameter

2.13 loadBillParameterFromCache

2.14 loadBillParameterObjectFromCache

2.15 getBillParameter

2.16 getGroupControlFields

2.17 getShowContentParameter

3.返回对象描述

参数开放接口

微信扫一扫：分享

相关文章

阅读排行