简要描述:
- 维数据类似于字典,比如数据库存储的值为1,1表示男,对于用户展示出来的是男,通过维的方式进行数据转换。
- 维数据核心字段为:id、parentId、value、name、level
- 维数据使用接口如下图:
- postman调用案例:
接口版本:
版本号 | 制定人 | 制定日期 | 修订日期 |
---|---|---|---|
v3 | 陈碧贵 | 2019-01-20 | xxxx-xx-xx |
请求URL:
http://{url参数}/bo/api/v3/{mkey} /dim/res/manager?columnField=mapperField&nodejs=common-dim-list&_dataT=string
_cacheR 表示强制刷新
- {mkey} 对应mapper文件
- {resField} 对应 {mkey}里面 responseField键
请求方式:
- GET
- POST
请求头:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
XownerId | 是 | string | 项目唯一ID,对应bo_project {ownerId} |
XsysId | 否 | string | 所属系统 对应 bo_system 表 |
XtenantId | 否 | string | 所属租户 对应 owner_bo_tenant 里面 ti_tenant_info 表 |
XuserFromFirstShareId | string | 否 | 一级分享用户ID, bo_user user_id |
XuserFromSecondShareId | string | 否 | 二级分享用户ID, bo_user user_id |
XverifyApi | 是 | string | 加密规则encryptByDES(`${newGuid()} |
XfilterAreaCode | 否 | string | 行政区编码, 对应 bo_sys_area area_code |
Content-Type: | 是 | string | application/json; charset=utf-8 请求类型 |
请求参数:
- 当事件发生时,调用http/https接口,传递参数信息,响应请求结果。
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
_columnField | 是 | string | mapperField 对应 mapper 文件中 dimDatas 键 |
_dataT | 否 | string | string/int 数据类型, 处理响应结果输出类型 |
_nodejs | 是 | string | common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线 |
_cacheR | 否 | boolean | true 强制新数据写入缓存 |
_userc | 否 | boolean | true 用户id作为缓存唯一key |
_cache | 否 | stirng | 缓存唯一识别key 通常配合用户ID使用 |
_ignoreRoot | 否 | stirng | 忽略根节点 paramsTemp._columnField.includes(‘parent’) |
_rootName | 否 | stirng | 自定义根节点名 默认 根节点 |
_rootValue | 否 | stirng | 自定义根节值,默认 0 |
返回示例:
正确时返回:
{
"data": [
{
name:null,
value:null
}
],
"cacheDate": "2021-01-22T12:25:11",
"code": 0,
"success": true
}
错误时返回:
{
"code": 0,
"message": ""
"error":{
errorCode:null,
errorText:null
}
"success": false,
}
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
success | bool | true 表示数据请求成功(跟code=0一致),调用者优先使用 |
code | int | true 表示数据请求成功(跟code=0一致),调用者优先使用 |
data | array | 响应的结果数据 name:显示的名称 value:交互的数据库中值 id:通常和value一致,树形结构需要 parentId: 父节点,树形结构需要level:等级,树形结构需要 |
cacheType | string | redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化) |
cacheDate | date | 最后数据获取时间 |
nodejs插件二次处理数据
fn-common-dim-list.js
// #region 添加根节点
if (!paramsTemp._ignoreRoot && (paramsTemp._columnField || '').includes('parent') && (argResult.data || []).filter(temp => (temp.value === '0' || temp.value === 0).length === 0)) {
argResult.data.unshift({
name: paramsTemp._rootName || "根节点",
value: paramsTemp._rootValue || "0"
});
} else if (paramsTemp._rootName && paramsTemp._rootValue) {
argResult.data.unshift({
name: paramsTemp._rootName || "根节点",
value: paramsTemp._rootValue || "0"
});
}
// #endregion 添加根节点
文档更新时间: 2023-12-11 08:11 作者:admin