1.32导出报告为文件流

<< Click to Display Table of Contents >>

当前位置:  部署与集成 > WebAPI 

1.32导出报告为文件流

复制链接

请求地址

http://ip:port/bi/api?action=downloadFile&token=xxxx

请求消息

请求参数

请求参数:xmlData(必填)

<?xml version="1.0" encoding="UTF-8"?>                        

<info>                        

<user>admin</user>                        

<rptPath>api/coffee</rptPath>                        

<fileType>pdf</fileType>                        

<params>                        

<param name="id" type="int">1</param>                        

</params>                        

</info>        

参数描述

user(选填):想要查看的目标用户的用户名。

rptPath(必填):报告的路径。

type(选填):报告的类型,参数值包括db、dblink、adb、vividdb、portalCell、vividdblink,未填写时为db。(10.1开始支持type参数)

db:分析报告。

dblink:分析报告的链接。

adb:即席分析报告。

vividdb:大屏报告。

vividdblink:大屏报告链接。

portalCell:组合报告。

fileType(必填):有pdf、xlsx、png、doc、docforedit、csv、pptx七种。扩展名写了zip时可以保存为压缩包。

doc为普通的Word,docforedit为Word易编辑模式。

说明:

type参数值为portalCell时,fileType仅支持pdf、xlsx

params(选填):可以不写。如果需要写,则需要写在param标签上。

params-param(选填): 需要带两个属性,一个是name,一个是type。

params-type的取值有:string、boolean、float、double、char、byte、short、int、long、date、time、dateTime。

注意:

当脚本赋值参数与api冲突时,先执行api,后执行脚本,即以脚本赋值参数为准,本接口返回的是字节流,若需要保存为文件请自行处理。

示例

function downloadFile() {

     var xml = getXml();

       $.post("http://" + ip + ":" + port + "/" + project + "/api?action=downloadFile&token=xxxx",

          {xmlData : xml},

          function(result) {

             writeXml(result);

          });

    }

响应消息

响应结果

成功:返回文件流,可进行保存操作。

错误:用户无权限

<?xml version="1.0" encoding="UTF-8"?>

<results>

  <result>

      <level>6</level>

      <message>用户“jessica”没有“读权限”访问:api/coffee。</message>

  </result>

</results>

结果描述

响应结果信息为xml,直接parse即可。

level 返回类型,不同数值代表不同返回状态,见附录

message为接口操作结果信息。

如果登陆非管理员账户想要查看其它人的数据,则会返回上述错误信息。