1.63替换数据集

<< Click to Display Table of Contents >>

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

1.63替换数据集

复制链接

支持的版本:9.1及以后

请求地址

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

请求消息

请求参数

请求参数:xmlData(必填)

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

<info>

<ref>

<path>API-测试</path>

<type>db</type>

</ref>

<querys>

<query>

 <oldRef>

  <type>sql</type>

<path>数据集-test</path>

 </oldRef>

 <newRef>

<type>sql</type>

<path>数据集-test_user</path>

 </newRef>

<cols>

<col>

<oldCol>旧列名1</oldCol>

<newCol>新列名1</newCol>

</col>

<col>

<oldCol>旧列名2</oldCol>

 <newCol>新列名2</newCol>

</col>

</cols>

</query>

</querys>

</info>

参数描述

ref-path(必填):需要替换报告的路径。

ref-type(必填):需要替换报告的类型:db、vividdb、vividdblink(10.1版本支持vividdb、vividdblink)。

db:分析报告。

dblink:分析报告的链接。

vividdb:大屏报告。

vividdblink:大屏报告链接。

querys-query-oldRef-type(必填):需要被替换的数据集类型。

querys-query-oldRef-path(必填):需要被替换的数据集路径。

querys-query-newRef-type(必填):需要进行替换的数据集类型。

querys-query-newRef-path(必填):需要进行替换的数据集路径。

querys-query-cols(选填):输入将报告中替换数据集用到的旧列映射到新列的集合,如果没有这个参数,默认寻找同列名的列进行替换,如果没有同列名的列如同现有逻辑一样进行报错。

说明:

query可以有多个,支持报告下所有组件对应数据集的替换。

10.0版本添加参数说明:

在querys-query中增加参数cols

cols(选填):输入将报告中替换数据集用到的旧列映射到新列的集合,如果没有这个参数,默认寻找同列名的列进行替换。

cols-col(选填,如果有cols至少填入一项):输入将报告中替换数据集用到旧列对应新列的映射。如果有这个参数没有覆盖所有用到的旧列,那没有写到的旧列默认寻找同列名的列进行替换。

cols-col-oldCol(在col中必填):输入原数据集中需要替换的列的列名,如果这个列不存在于query-oldRef,返回结果报错提示“操作失败,数据集xxx中找不到数据列xxx”,如果这个列存在但是不存在于原db则不进行处理。

cols-col-newCol(在col中必填):输入将oldCol替换为新数据集的列的列名,如果这个列不存在于query-newRef,返回结果报错提示“操作失败,数据集xxx中找不到数据列xxx”。

示例

function replaceDbQuery() {

       var xml = getXml();

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

          {xmlData : xml},

          function(result) {        

             writeXml(result);

          });

    }

响应消息

响应结果

操作成功

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

<results>

<result>

 <level>1</level>

 <message>配置成功。</message>

</result>

</results>

操作失败

资源找不到:

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

<results>

<result>

<level>6</level>

<message>\vividime\bihome\dashboard\tes1t.db (系统找不到指定的文件。)</message>

</result>

</results>

被替换或者需要进行替换的数据集信息错误:

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

<results>

<result>

<level>6</level>

<message>报告中不存在数据集"test"。</message>

</result>

</results>

query-oldRef不存在输入的oldCol/ query-newRef不存在输入的newCol:

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

<results>

<result>

<level>6</level>

<message>操作失败,数据集“咖啡1”中找不到数据列“产品种类”。</message>

</result>

</results>

结果描述

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

level 返回类型,不同数值代表不同返回状态,见附录

message为接口操作结果信息。