1.106导出为模板

<< Click to Display Table of Contents >>

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

1.106导出为模板

复制链接

支持的版本:10.2及以后

请求地址

http://ip:port/bi/api?action=downloadTemplate&token=xxxx&resource=deployJar

请求消息

请求参数

请求参数:xmlData(必填)

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

<info>                        

<user>admin</user>                        

<path>api/coffee</path>                                            

<type>db</type>

<template>年度运营报告</template>

</info>

参数描述

 

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

path(必填):需要导出的报告所在路径。

type(必填):报告类型,包括db、dblink、vividdb、vividdblink,组合报告、即席分析不支持。

template(非必填):导出时保存的模板id,使用模板新建空白报告时需要输入该模板id。若未填写内容,导出时会以“报告名_随机数”的方式生成模板id,以确保模板的唯一性,您可以从jar文件内查看具体的id,例如:年度运营报告_1640774381755_76。

 

示例

function downloadTemplate() {

       var xml = getXml();

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

          {xmlData : xml},

          function(result) {

          writeXml(result);

       });

    }

响应消息

响应结果

操作成功

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

<results>

 <result>

<level>1</level>

    <message>操作成功。</message>

 </result>

</results>

 

操作失败

登录名或密码错误:

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

<results>

 <result>

    <level>6</level><message>登录名或密码错误</message>

 </result>

</results>

 

未获取到报告文件:

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

<results>

 <result>

 <level>6</level>

<message>未获取到报告文件:{0}</message>

 </result>

</results>

 

没有导出为模板操作权限:

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

<results>

 <result>

 <level>6</level><message>用户“hunk1”没有导出为模板操作权限</message>

 </result>

</results>

结果描述

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

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

message为接口操作结果信息