1.32 导出仪表盘为文件流

<< Click to Display Table of Contents >>

当前位置:  系统集成 > WebAPI 

1.32 导出仪表盘为文件流

Previous pageReturn to chapter overviewNext page

请求地址

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>        

参数描述

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

2)rptPath(必填):仪表盘的路径。

3)fileType(必填):有pdf、xls、png、doc、csv五种。ps:当为csv时,保存的文件的扩展名需要写zip。

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

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

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即可。

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

2)  message为接口操作结果信息。

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