1.38 批量获得仪表盘中表格、交叉表、图表、文本组件的数据

<< Click to Display Table of Contents >>

当前位置:  系统集成 > WebAPI 

1.38 批量获得仪表盘中表格、交叉表、图表、文本组件的数据

Previous pageReturn to chapter overviewNext page

请求地址

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

请求消息

请求参数

请求参数:xmlData(必填)

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

<info >                        

 <user>admin</user>                        

 <dbpath>api/coffee</dbpath>                        

 <elements>                        

   <element>                        

     <name>图表1</name>                        

     <page>                        

       <pageSize>2</pageSize>                        

       <pageNow>2</pageNow>                        

     </page>                        

   </element>                                                

 </elements>                        

 <params>                        

   <param name="market">Central</param>                        

 </params>                        

</info>

 

参数描述

参数为节点信息:

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

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

3)name(必填):仪表盘元素名称

4)pageSize(选填) 和 pageNow(选填) 的值需要大于等于1。pageSize是每页显示多少条,pageNow是返回第几页的结果。

5)params(选填)里面可以传一些参数,对查询进行控制。type是参数的类型,主要有以下几种:string 、boolean、float、double、char、byte、short、int、long、date、time 、dateTime。如果参数有多个值, 用逗号","分隔即可。

6)日期类型的参数格式如下:

date的格式为 "yyyy-MM-dd"

datetime的格式为 "yyyy-MM-dd HH:mm:ss"

time的格式为 "HH:mm:ss"

示例

function getData() {

        var xml = getXml();

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

           {xmlData : xml},

           function(result) {

           writeXml(result);

        });

     }

响应消息

响应结果

操作成功

<info>

   <elem name="图表1">

       <page>

           <rowCount>1</rowCount>        <-- 数据量的大小 -->

           <pageCount>1</pageCount>     <-- 总的页数 -->

           <pageSize>5</pageSize>            <-- 每页数据量的大小 -->

           <pageNow>1</pageNow>          <-- 当前页 -->

       </page>

       <type>Stacked Bar</type>

       <grid>

           <row>

               <header type="string">MARKET</header>

               <header type="int">Sum_ID</header>

           </row>

           <row>

               <col>Central</col>

               <col>2774016</col>

           </row>

       </grid>

   </elem>

</info>

结果描述

1)type标签为图表的类型,见附录 。不能使用自动类型和组织图,否则type没有值。如果一个图表包含多种类型,则会得到多个类型以逗号拼接的字符串。

2)grid标签为返回数据表结构。其中row为行,header为列名,col为列。标签内分别对应相应的值。非管理员账户不能查看其它账户数据。

注意:交叉表只支持单行表头的交叉表。