简要描述:

  • 生成导出模板需要的参数

接口版本:

版本号 制定人 制定日期 修订日期
v3 陈碧贵 2019-01-20 xxxx-xx-xx

请求URL:

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

请求方式:

  • 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 请求类型
Authorization string 当前用户认证信息,通过登录接口获取 Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6

请求参数:


{
  "url": "~/App_Temp/Excels/idc/idc-resource-space-statistics/template_idc-resource-space-statistics_settings.xlsx",
  "data":{"data":[{"power":112,"site":644,"room":37,"it":76,"groupNameReadonly":1,"dataDateReadonly":1,"groupName":"中心园区","schemaGroupId":"0_121","resEnumId":"idc-c-deve-idc-2020-9814af3b-fa3d-40","groupId":"0_121","uCapacity":900,"coolingTower":500,"waterStorage":1000,"modifyUserId":"member","waterSupplyIn":17.3,"waterSupplyOut":26.1,"backWaterIn":13.1,"backWaterOut":29.6,"equWg":89,"equCooling":188,"equElse":358,"uUsed":78,"fireSmoke":11,"siteLs":33,"upsI":33,"upsU":455,"diffTableNo":0,"auditStatus":{"name":"待审核","value":2},"sysId":{},"auditTime":{"name":"2021-06-18 14:35:01","value":"2021-06-18T14:35:01"},"createTime":{"name":"2021-06-11 07:13:18","value":"2021-06-11T07:13:18"},"dataDate":{"name":"2021-06","value":"2021-06-11T07:13:18"},"modifyTime":{"name":"2021-06-18 14:35:01","value":"2021-06-18T14:35:01"},"runStart":{"name":"2021-01-04","value":"2021-01-04T00:00:00"},"createUserId":"cbg5"}],"code":"0","success":true}
}

  • 第一个data存放要被转换的对象;第二个data 里面数可以为对象或者数组。
  • url为模板地址
参数名 是否必须 类型 说明
_menuId string  对应表bo_sys_menu 里面menu_id, 如果需要授权的接口,_menuId必须传递
_nodejs string common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线

返回示例:

正确时返回:

{
  "url": "fi9BcHBfVGVtcC9FeGNlbHMvaWRjL2lkYy1yZXNvdXJjZS1zcGFjZS1zdGF0aXN0aWNzL3RlbXBsYXRlX2lkYy1yZXNvdXJjZS1zcGFjZS1zdGF0aXN0aWNzX3NldHRpbmdzLnhsc3g=",
  "content": "{\\"data\\":[{\\"power\\":112,\\"site\\":644,\\"room\\":37,\\"it\\":76,\\"groupNameReadonly\\":1,\\"dataDateReadonly\\":1,\\"groupName\\":\\"中心园区\\",\\"schemaGroupId\\":\\"0_121\\",\\"resEnumId\\":\\"idc-c-deve-idc-2020-9814af3b-fa3d-40\\",\\"groupId\\":\\"0_121\\",\\"uCapacity\\":900,\\"coolingTower\\":500,\\"waterStorage\\":1000,\\"modifyUserId\\":\\"member\\",\\"waterSupplyIn\\":17.3,\\"waterSupplyOut\\":26.1,\\"backWaterIn\\":13.1,\\"backWaterOut\\":29.6,\\"equWg\\":89,\\"equCooling\\":188,\\"equElse\\":358,\\"uUsed\\":78,\\"fireSmoke\\":11,\\"siteLs\\":33,\\"upsI\\":33,\\"upsU\\":455,\\"diffTableNo\\":0,\\"auditStatus\\":{\\"name\\":\\"待审核\\",\\"value\\":2},\\"sysId\\":{},\\"auditTime\\":{\\"name\\":\\"2021-06-18 14:35:01\\",\\"value\\":\\"2021-06-18T14:35:01\\"},\\"createTime\\":{\\"name\\":\\"2021-06-11 07:13:18\\",\\"value\\":\\"2021-06-11T07:13:18\\"},\\"dataDate\\":{\\"name\\":\\"2021-06\\",\\"value\\":\\"2021-06-11T07:13:18\\"},\\"modifyTime\\":{\\"name\\":\\"2021-06-18 14:35:01\\",\\"value\\":\\"2021-06-18T14:35:01\\"},\\"runStart\\":{\\"name\\":\\"2021-01-04\\",\\"value\\":\\"2021-01-04T00:00:00\\"},\\"createUserId\\":\\"cbg5\\"}],\\"code\\":\\"0\\",\\"success\\":true}"
}


错误时返回:

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

返回参数说明:

参数名 类型 说明
success bool true 表示数据请求成功(跟code=0一致),调用者优先使用
code int true 表示数据请求成功(跟code=0一致),调用者优先使用
url {} url Base64加密
content {} Json参数数据
cacheType string redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化)
cacheDate date 最后数据获取时间

模板配置和制作




文档更新时间: 2024-05-01 18:11   作者:admin