简要描述:
接口版本:
版本号 |
制定人 |
制定日期 |
修订日期 |
v3 |
陈碧贵 |
2024-05-12 |
xxxx-xx-xx |
请求URL:
- {mkey} 对应mapper文件
- {resField} 对应 {mkey}里面 responseField键
请求方式:
请求头:
参数名 |
是否必须 |
类型 |
说明 |
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接口,传递参数信息,响应请求结果。
参数名 |
是否必须 |
类型 |
说明 |
datafile |
否 |
string |
文件路径,base64加密 ~/App_Export/{ownerId}/Pdfs/gzsb/data.xlsx (POST 请求可不传递) |
template |
是 |
string |
模板文件目录 \RG3.Web.Host.PaaS\App_Data\TemplatesBiz\pdf\gzsb |
_nodejs |
是 |
string |
common-data 对应/Config/AppNodeJs/Plugins/fn- common-data.js, 通过nodejs插件,对响应结果进行二次处理 common-data 普通数据(小写驼峰)common-data-under 普通数据下划线 |
file |
否 |
string |
POST 请求时候传递 IFormFile file |
返回示例:
正确时返回:
{
"sucess": true,
"data": {
"message": "导出11条",
"source": "~/App_Export/basis/Pdfs/gzsb/data.xlsx",
"target": "~/App_Export/basis/Pdfs/gzsb",
"files": [
{
"value": "~/App_Export/basis/Pdfs/gzsb/xxx.pdf",
"name": "xxx.pdf"
}
]
}
}
错误时返回:
{
"code": 0,
"message": ""
"error":{
errorCode:null,
errorText:null
}
"success": true,
}
返回参数说明:
参数名 |
类型 |
说明 |
success |
bool |
true 表示数据请求成功(跟code=0一致),调用者优先使用 |
code |
int |
true 表示数据请求成功(跟code=0一致),调用者优先使用 |
data |
array |
响应的结果数据 name:显示的名称 value:交互的数据库中值 id:通常和value一致,树形结构需要 parentId: 父节点,树形结构需要level:等级,树形结构需要 |
data.files |
array |
返回转换后的pdf存储路径 |
data.source |
string |
模板来源路径 |
data.target |
string |
模板模板路径 |
cacheType |
string |
redis/sqlite/local 数据来源缓存 的类型(便于开发调试和性能优化) |
cacheDate |
date |
最后数据获取时间 |
文档更新时间: 2024-05-12 11:33 作者:admin