在集成到业务系统时,有时候在不通过网页预览报表就能直接导出各类文件,为满足此类需求,乐创者服务开放了一个报表结果导出文件的接口,通过传入的报表名称、参数值,即可自动执行报表并导出为Excel、PDF、Word、Txt、cvs等格式的文件。
1 请求地址
Request Method:GET
Request URL:{http}://{ip}:{port}{/lczServer}/ExportReportResult?请求参数
组成说明
{http} 网络协议名称,支持http或https两种方式
{ip} 乐创者服务程序部署所在的服务器地址,支持ip地址或域名
{port} 乐创者服务程序部署所在Web应用的访问端口。如果是80端口,可缺省
{/lczServer} 乐创者服务程序部署时的应用上下文根目录(Web Context-root),可根据业务需要进行设置。如放在“ROOT”下时,内容为空即可;如果上下文根目录为“test”,则应该写“/test”
2 请求参数
参数值包含中文或特殊字符时需URL编码。
javascript代码示例:url += ‘&variants=’ + encodeURIComponent(‘年份=2019;月份=1’)
java代码示例:url += “&variants=” + java.net.URLEncoder.encode(“年份=2019;月份=1”, “UTF-8”)
必选参数
参数名 |
类型 |
默认值 |
说明 |
---|---|---|---|
authId | string | 公开方式访问报表:此参数不设置, 也可以使用公开身份的authId值(authId=anonymous_admin)。 非公开方式访问报表:可使用登录乐创者服务成功后返回的authId值(authId=xxxxxxxxxxxx) 如果系统配置中开启了‘允许公开访问’,则可通过公开方式直接查看报表。 |
|
targetVolume | string | 报表模板文件所属应用内部名称 | |
fileName | string | 报表模板文件文件内部名称 |
“公开访问”在历史版本中也称之为”匿名访问”。、
可选参数
参数名 |
类型 |
默认值 |
说明 |
---|---|---|---|
variants | string | 报表参数串,格式为:param1=值;param2=值 如果参数串中包含中文内容,则需要进行编码,转换成UTF-8编码格式 例如:variants=param1=1;param2=2; |
|
exportType | string | excel | 导出格式类型,excel\pdf\txt ; exportType参数为空的话,则默认为导出excel。 |
expFileType | string | xlsx | 指定导出excel的版本,xlsx\xls ,默认为 xlsx |
returnType | string | binary | 返回结果类型,binary\fileName; binary:把导出的结果已二进制流的形式返回;fileName:把导出的结果存储为文件,然后返回文件名及路径。returnType参数为空,则默认为binary类型。 |
pathType | string | real | 返回的文件路径类型。当returnType为 fileName 时,pathType 设置返回的路径类型。real\relative , 为空,则默认为real,返回绝对路径,如 D:/tomcat/webapps/lczServer/downloadfiles/test.xls ; relative : 返回相对路径,如 downloadfiles/test.xls |
pageToSheet | boolean | false | 分页分sheet开关,true\false; 报表只有一个sheet时起作用。pageToSheet参数为空,则默认为false。 |
3 返回结果
returnType参数为binary时Xml格式,如下:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<ExcelFile>
<R>
<UZL>原始长度</UZL>
<ZL>压缩后长度</ZL>
<D>二进制压缩内容</D>
</R>
</ExcelFile>
<Infos>
<Info>提示信息</Info>
</Infos>
<Errors>
<Error>错误信息</Error>
</Errors>
</Response>
returnType参数为fileName时Xml格式,如下:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<ExcelFile>
<R>
<D>文件路径</D>
</R>
</ExcelFile>
<Infos>
<Info>提示信息</Info>
</Infos>
<Errors>
<Error>错误信息</Error>
</Errors>
</Response>
作者:柳杨 创建时间:2023-08-02 13:46
最后编辑:wangjingxin 更新时间:2025-04-22 15:31
最后编辑:wangjingxin 更新时间:2025-04-22 15:31
