1.105获取模板列表

<< Click to Display Table of Contents >>

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

1.105获取模板列表

复制链接

支持的版本:10.2及以后

请求地址

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

请求消息

请求参数

请求参数:xmlData

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

<info>

<user>admin</user>

<position>online</position>

<deviceType>pc</deviceType>

<industry>1</industry>

<department>12</department>

<style>24</style>

</info>

参数描述

user(选填):为想要查看的目标用户,未填写时取session对应的用户。

position(选填):模板位置,可以是online:在线,local:本地,未填写时默认为本地;

deviceType(选填):设备类型,可以是pc:PC端、mobile:移动端。

industry(选填):适用行业id,可以是1:金融、2:制造、3:地产、4:交通、5:电力、6:电信、7:医疗、8:电商、9:互联网、10:政府、11:高校。

department(选填):适用部门id,可以是12:销售、13:财务、14:采购、15:生产、16:仓储、17:运营、18:人力。

style(选填):风格id,可以是19:大屏、20:简约、21:炫酷、22:商务、23:绚丽、24:其他。

说明:

选填的部分未填写时,获取到的是“全部”数据,本地模板选填部分不生效。

 

示例

function updateTemplateTree () {

       var xml = getXml();

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

          {xmlData :xml},

          function(result) {

          writeXml(result);

       });

    }

响应消息

响应结果

操作成功

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

<results>

 <assetref

name="财务系统可视化看板"

template="财务系统可视化看板1644410561446_18"

webImage="https://yh-market-1252949735.cos.ap-beijing.myqcloud.com/templates/images/43-thumbnail.jpg"

webPreImage="https://yh-market-1252949735.cos.ap-beijing.myqcloud.com/templates/images/43-preview.jpg"

instruction="该模板适用于财务人员统计分析各项业务指标的情况,包括了数据统计指标卡、业务发展、重点产品销售额、客户拓展、经营效率、柜面交易量、中间业务收入几个部分,可以比较全面地分析财务数据。">

       <departments>

           <department type="13"/>

           <department type="12"/>

       </departments>

       <styles>

           <style type="20"/>

           <style type="22"/>

       </styles>

       <industrys>

           <industry type="1"/>

           <industry type="2"/>

           <industry type="3"/>

           <industry type="4"/>

           <industry type="5"/>

           <industry type="6"/>

           <industry type="8"/>

       </industrys>

   </assetref>

</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,直接parse即可。

assetref下面分别有每个模板的name、template(template为模板id)、图片链接、使用场景描述、departments、styles、industrys。

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

message为接口操作结果信息