简要描述：

  • 应用配置信息

接口版本：

版本号 制定人 制定日期 修订日期
v3 陈碧贵 2023-05-22 xxxx-xx-xx

请求URL:

http://localhost:5900/bo/api/v3/bo-app-config-setting/list/res/view?_nodejs=common-data&_mapperType=glogal&appId=4164538169947066368&_rmtSecond=L2O&pageSize=1&_rmtKvT=origial

  • {mkey} 对应mapper文件
  • {resField} 对应 {mkey}里面 responseField键

请求方式：

  • GET
  • POST

请求头：

参数名 是否必须 类型 说明
XownerId 是 string 项目唯一ID,对应bo_project {ownerId}
XsysId 否 string 所属系统 对应 bo_system 表
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接口，传递参数信息，响应请求结果。
  • _rmtKvT和_rmtKv选择其中之一
参数名 是否必须 类型 说明
appId 是 string 应用ID
pageSize 是 string 应用ID
_rmtSecond 否 string 二级转换类型 L2O
_rmtKv 否 string kv转原始值的列 appTheme,isToMourn
_rmtKvT 否 string kv转原始值的列 _rmtKvT=origial 关联配置文件rmtKvMappers
_nodejs 是 string common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js， 通过nodejs插件，对响应结果进行二次处理 common-data 普通数据（小写驼峰）common-data-under 普通数据下划线

返回示例:

正确时返回（无_rmtKv）:

{
    "data": {
        "meta": {},
        "appId": "4164538169947066368",
        "appName": "禅客",
        "appPcPoster": "5",
        "appPoster": "5",
        "commodityPolicy": "5",
        "constructionParty": "5",
        "memberPolicy": "5",
        "privacyPolicy": "4",
        "settingId": "AS4164538169947066368",
        "supervisionUnit": "5",
        "technicalSupport": "5",
        "userAgreement": "3",
        "userManual": "4",
        "diffTableNo": 0,
        "appTheme": {
            "name": "光年红",
            "value": "lightyear-red"
        },
        "isToMourn": {
            "name": "是",
            "value": 1
        }
    },
    "currentDay": "2023-05-22",
    "cacheDateTimestamp": 0,
    "code": "0",
    "retCode": "0",
    "success": true
}

正确时返回（有_rmtKv）:

{
    "data": {
        "meta": {},
        "appId": "4164538169947066368",
        "appName": "禅客",
        "appPcPoster": "5",
        "appPoster": "5",
        "commodityPolicy": "5",
        "constructionParty": "5",
        "memberPolicy": "5",
        "privacyPolicy": "4",
        "settingId": "AS4164538169947066368",
        "supervisionUnit": "5",
        "technicalSupport": "5",
        "userAgreement": "3",
        "userManual": "4",
        "diffTableNo": 0,
        "appTheme": "lightyear-red",
        "isToMourn": 1
    },
    "currentDay": "2023-05-22",
    "cacheDateTimestamp": 0,
    "code": "0",
    "retCode": "0",
    "success": true
}

错误时返回:

{
    "code": 0,
    "message": ""
    "error":{
      errorCode:null，
      errorText:null
    }
    "success": false,
}

返回参数说明:

参数名 类型 说明
success bool true 表示数据请求成功（跟code=0一致）,调用者优先使用
code int true 表示数据请求成功（跟code=0一致）,调用者优先使用
data object 响应的结果数据 name:显示的名称 value:交互的数据库中值 id:通常和value一致，树形结构需要 parentId: 父节点，树形结构需要level:等级，树形结构需要
cacheType string redis/sqlite/local 数据来源缓存 的类型（便于开发调试和性能优化）
cacheDate date 最后数据获取时间

文档更新时间: 2023-05-22 20:18   作者：admin