1.49获取报告血缘分析数据

<< Click to Display Table of Contents >>

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

1.49获取报告血缘分析数据

复制链接

请求地址

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

请求消息

请求参数

请求参数:xmlData(必填)

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

<info>      

<user></user>  

<getdata>      

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

<type>1</type>    

</getdata>

</info>

参数描述

参数为节点信息:

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

dbpath(必填):报告的路径。

type(必填):报告类型,参数的可选值包括1、2、3、4、5、6。

1:分析报告。

2:分析报告的链接。

3:即席分析报告。

4:大屏报告。

5:组合报告。

6:大屏链接报告。

示例

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、数据源,详情参考LINEAGE_RESOURCE表中的type

detailType:节点详细类型,适用于报告的组件类型、数据集的类型,详情参考LINEAGE_RESOURCE表中的detailType

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

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

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

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

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

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

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

relations:节点之间的关系。

source:连线的起始节点。

target:连线的目标节点。

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