Request address

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

Request message

Request parameter

required parameter:xmlData (required)

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

<info>      

<user></user>  

<getdata>      

<querypath>table</querypath>  

<type>1</type>    

</getdata> </info>

parametric description

Parameter is node information :

1) user(optional)：The target user name you want to view

2) querypath(required)：dashboard path

3) type(required)：query path

Sample

function getQryLineage() {

        var xml = getXml();

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

           {xmlData : xml},

           function(result) {

           writeXml(result);

        });

     }

Response message

Response result

1) Successful operation

<?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>

2）Operation failure

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

<results>

   <result>

       <level>6</level>

       <message>User 'user1' is not found.</message>

   </result>

</results>

Result description

The response result information is xml, direct parse.

nodes:List of nodes

node:node

id:node id

root:node is the starting node selected by the query

name: the name of the node

type: type of node, including reports, component datasets, data tables (Mongo sets), custom SQL, data sources

detailType: Node detail type, applicable to the reported component type, type of data set

path: if a node reports, data set, data source, show its physical path under bihome, if a data table or Mongo collection show the selected hierarchical path

qryPath: The physical path of a dataset resource under bihome for nodes with a custom SQL type.

qryType: The type of the dataset resource (SQL dataset, Mongo dataset, etc.) for nodes with a custom SQL type.

script:script, SQL or mongo pipeline statement for SQL dataset, Mongo dataset

assetPath: the physical path of a resource under bihome

Does isAsset:node represent a resource

read: whether or not you have write permission for the resource, applies to the node that represents the resource.

relations: relationships between nodes

source:Start node of a link

target:target node of a link

statistics: statistical information on which nodes are dependent by other nodes

id: ID of the node

query:the number of data sets that depend on the node

dashboard: the number of reports that rely on the node

Level return type, different values represent different return status, 1 indicates success, 6 indicates failure.