1.50 获取数据集血缘分析数据

<< Click to Display Table of Contents >>

当前位置:  系统集成 > WebAPI 

1.50 获取数据集血缘分析数据

Previous pageReturn to chapter overviewNext page

请求地址

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

请求消息

请求参数

请求参数:xmlData(必填)

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

<info>      

<user></user>  

<getdata>      

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

<type>1</type>    

</getdata> </info>

 

参数描述

参数为节点信息:

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

2) querypath(必填):数据集的路径

3) type(必填):数据集类型

示例

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>Mongo_管道语句</name>

     <detailType>16907</detailType>

     <detailTypeString>Mongo数据集</detailTypeString>

     <type>3</type>

     <path>webapi/getQryLineage/Mongo数据集/Mongo_管道语句</path>

     <assetPath>webapi/getQryLineage/Mongo数据集/Mongo_管道语句</assetPath>

     <isAsset>true</isAsset>

     <read>true</read>

   </node>

   <node>

     <id>2</id>

     <root>false</root>

     <name>管道操作语句</name>

     <qryPath>webapi/getQryLineage/Mongo数据集/Mongo_管道语句</qryPath>

     <qryType>16907</qryType>

     <detailType>16907</detailType>

     <path>test/coffee_chain</path>

     <detailTypeString>管道操作语句</detailTypeString>

     <type>5</type>

     <isAsset>false</isAsset>

   </node>

   <node>

     <id>3</id>

     <root>false</root>

     <name>Mongo数据源</name>

     <detailType>16903</detailType>

     <detailTypeString>MongoDB</detailTypeString>

     <type>6</type>

     <path>数据源/血缘分析_数据源/其他数据源/Mongo数据源</path>

     <assetPath>___CONNECTION___/血缘分析_数据源/其他数据源/Mongo数据源</assetPath>

     <isAsset>true</isAsset>

     <read>true</read>

   </node>

 </nodes>

 <relations>

   <relation>

     <source>1</source>

     <target>2</target>

   </relation>

   <relation>

     <source>2</source>

     <target>3</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:连线的目标节点

statistics:节点被其他节点依赖的统计信息

id:节点的ID

query:依赖该节点的数据集个数

dashboard:依赖该节点的报告的个数

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