1.49 获取报告血缘分析数据

<< Click to Display Table of Contents >>

当前位置:  系统集成 > WebAPI 

1.49 获取报告血缘分析数据

Previous pageReturn to chapter overviewNext page

请求地址

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

请求消息

请求参数

请求参数:xmlData(必填)

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

<info>      

<user></user>  

<getdata>      

<dbpath>新建文件夹/血缘分析</dbpath>    

</getdata> </info>

 

参数描述

参数为节点信息:

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

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

示例

function getDbLineage() {

        var xml = getXml();

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

           {xmlData : xml},

           function(result) {

           writeXml(result);

        });

     }

响应消息

响应结果

操作成功

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

<lineage>

 <nodes>

   <node>

     <id>1</id>

     <root>true</root>

     <name>86表格</name>

     <detailType>16640</detailType>

     <detailTypeString>报告</detailTypeString>

     <type>1</type>

     <path>webapi/getDbLineage/86表格</path>

     <assetPath>webapi/getDbLineage/86表格</assetPath>

     <isAsset>true</isAsset>

     <read>true</read>

   </node>

   <node>

     <id>2</id>

     <root>false</root>

     <name>表1</name>

     <detailType>2</detailType>

     <detailTypeString>表</detailTypeString>

     <type>2</type>

     <isAsset>false</isAsset>

   </node>

   <node>

     <id>3</id>

     <root>false</root>

     <name>交叉表1</name>

     <detailType>3</detailType>

     <detailTypeString>交叉表</detailTypeString>

     <type>2</type>

     <isAsset>false</isAsset>

   </node>

   <node>

     <id>4</id>

     <root>false</root>

     <name>自由式表格1</name>

     <detailType>16</detailType>

     <detailTypeString>自由式表格</detailTypeString>

     <type>2</type>

     <isAsset>false</isAsset>

   </node>

   <node>

     <id>5</id>

     <root>false</root>

     <name>ExcelQuery</name>

     <detailType>16905</detailType>

     <detailTypeString>Excel数据集</detailTypeString>

     <type>3</type>

     <path>webapi/getQueryData/ExcelQuery</path>

     <assetPath>webapi/getQueryData/ExcelQuery</assetPath>

     <isAsset>true</isAsset>

     <read>true</read>

   </node>

   <node>

     <id>6</id>

     <root>false</root>

     <name>咖啡中国市场销售数据</name>

     <detailType>16897</detailType>

     <detailTypeString>SQL数据集</detailTypeString>

     <type>3</type>

     <path>咖啡中国市场销售数据</path>

     <assetPath>咖啡中国市场销售数据</assetPath>

     <isAsset>true</isAsset>

     <read>true</read>

   </node>

   <node>

     <id>7</id>

     <root>false</root>

     <name>自定义SQL语句</name>

     <qryPath>咖啡中国市场销售数据</qryPath>

     <qryType>16897</qryType>

     <detailType>16897</detailType>

     <detailTypeString>SQL语句</detailTypeString>

     <type>5</type>

     <isAsset>false</isAsset>

   </node>

   <node>

     <id>8</id>

     <root>false</root>

     <name>自定义数据源</name>

     <detailType>5</detailType>

     <detailTypeString>Generic</detailTypeString>

     <type>6</type>

     <read>true</read>

   </node>

 </nodes>

 <relations>

   <relation>

     <source>1</source>

     <target>2</target>

   </relation>

   <relation>

     <source>1</source>

     <target>3</target>

   </relation>

   <relation>

     <source>1</source>

     <target>4</target>

   </relation>

   <relation>

     <source>2</source>

     <target>6</target>

   </relation>

   <relation>

     <source>3</source>

     <target>5</target>

   </relation>

   <relation>

     <source>4</source>

     <target>5</target>

   </relation>

   <relation>

     <source>6</source>

     <target>7</target>

   </relation>

   <relation>

     <source>7</source>

     <target>8</target>

   </relation>

 </relations>

</lineage>

操作失败

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

<results>

   <result>

       <level>6</level>

       <message>用户“user1”不存在。</message>

   </result>

</results>

结果描述

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

nodes:节点列表

node:节点

id:节点id

root:节点是否是是查询选中的起始节点

name:节点的名字

type:节点的类型,包含报告、组件数据集、数据表(Mongo集合)、自定义SQL、数据源

detailType:节点详细类型,适用于报告的组件类型、数据集的类型

path:如果节点时报告、数据集、数据源,显示其在bihome下的物理路径,如果是数据表或者Mongo集合显示选择的层级路径

qryPath:数据集资源在bihome下的物理路径,适用于类型为自定义SQL的节点。

qryType:数据集资源的类型(SQL数据集、Mongo数据集等),适用于类型为自定义SQL的节点。

script:脚本,sql或者mongo管道语句,适用于SQL数据集、Mongo数据集

assetPath:资源在bihome下的物理路径

isAsset:节点是否表示一个资源

read:是否拥有资源的写权限,适用于表示资源的节点。

relations:节点之间的关系

source:连线的起始节点

target:连线的目标节点

 1)level 返回类型,不同数值代表不同返回状态,1表示成功, 6表示失败。

 

参数说明

type

名称

detailType

名称

1

报告

22016

收藏的报告

21248

分享的报告

16440

报告

2

组件

1

图表

2

3

交叉表

4

图片

5

日期过滤

6

列表过滤

7

范围过滤

8

组件

9

文本

10

仪表

11

文本参数

14

下拉参数

15

选项卡

16

自由式表格

17

填报参数

18

20

过滤容器

21

树状过滤

22

列表参数

23

提交

26

网页

27

定制组件

28

轮播

3

数据集

16897

SQL数据集

16905

Excel数据集

16904

组合数据集

16910

自服务数据集

16902

内嵌数据集

19600

数据集市数据集

16907

Mongo数据集

16899

定制数据集

16898

Script数据集

16912

多维数据集

4

物理表

18436

视图

18438

多维数据集Cube

18442

Kylin的Cube

18439

属性视图

18440

分析视图

18441

计算视图

5

自定义SQL

1

SQL脚本

2

SQL存储过程

3

Mongo管道语句

6

数据源

0

Generic

1

Oracle

2

DB2

3

SQL Server

4

MySQL

5

Derby

6

Informix

7

Sybase

8

Access

9

Vertical

10

Yonghong

11

Hive

12

Mongo

13

Spark

14

Postgresql

15

Hana

16

Kylin

17

Max Compute

18

Kingbase

19

Impala

20

HBase

21

Presto

22

AnalyticDB

23

Essbase

24

SAP BW

25

SSAS

27

Teradata

28

GBase

29

Transwarp

30

Sparking

32

HuaWeiCloud DWS

33

GaussDB

34

FusionInsight ELK

35

FusionInsight HD

36

ELASTIC SEARCH

37

GREENPLUM

40

ThunderEngine

41

GaussDB 100