请求地址

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

请求消息

请求参数

请求参数：xmlData（必填）

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

<info>      

<user></user>  

<getdata>      

<querypath>txt</querypath>

<type>2</type>    

</getdata>

</info>

参数描述

参数为节点信息：

•user（选填）：想要查看的目标用户名

•querypath（必填）：数据集的路径

•type（必填）：数据集类型

1-SQL数据集

2-Excel数据集

3-组合数据集

4-自服务数据集

5-Mongo数据集

6-数据集市数据集

7-多维数据集

8-内嵌数据集

9-定制数据集

示例

function getQryLineage() {

       var xml = getXml();

       $.post("http://" + ip + ":" + port + "/" + project + "/api?action=getQryLineage&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>txt</name>

           <detailType>16905</detailType>

           <detailTypeString>Excel数据集</detailTypeString>

           <type>3</type>

           <path>txt</path>

           <assetPath>txt</assetPath>

           <isAsset>true</isAsset>

           <qryInDashboard>false</qryInDashboard>

           <files>excel/b/f/excel-1716347491268-10-115312.txt</files>

       </node>

       <node>

           <dbid>816472e6-a4b2-41a5-87b0-125639dbe6dc</dbid>

           <createTime>2024-05-23 13:20:18</createTime>

           <id>2</id>

           <root>false</root>

           <name>txt</name>

           <detailType>16640</detailType>

           <detailTypeString>报告</detailTypeString>

           <type>1</type>

           <path>txt</path>

           <assetPath>txt</assetPath>

           <isAsset>true</isAsset>

           <qryInDashboard>false</qryInDashboard>

       </node>

       <node>

           <id>3</id>

           <root>false</root>

           <name>图表1</name>

           <detailType>2</detailType>

           <detailTypeString>表</detailTypeString>

           <type>2</type>

       </node>

   </nodes>

   <relations>

       <relation>

           <source>2</source>

           <target>3</target>

       </relation>

       <relation>

           <source>3</source>

           <target>1</target>

       </relation>

   </relations>

   <statistics>

       <node>

           <id>1</id>

           <influence>

               <query>0</query>

               <experiment>0</experiment>

               <dashboard>0</dashboard>

           </influence>

       </node>

   </statistics>

</lineage>

•操作失败

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

<results>

  <result>

      <level>6</level>

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

  </result>

</results>

结果描述

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

•nodes：节点列表。

•node：节点。

•id：节点id。

•dbid：如果节点类型是报告，将会返回该报告的资源ID。

•createTime：如果节点类型是报告，将会返回该报告的创建时间。

•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下的物理路径。

•qryInDashboard：是否为制作报告中增加的内嵌数据集、组合数据集。

•files：文本文件信息，包含xls、xlsx、csv、txt、log。

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

•read：是否拥有资源的读权限，适用于表示资源的节点。

•relations：节点之间的关系。

•source：连线的起始节点。

•target：连线的目标节点。

•statistics：节点被其他节点依赖的统计信息。

•id：节点的ID。

•query：依赖该节点的数据集个数。

•dashboard：依赖该节点的报告的个数。

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