数据集新建计算列

<< Click to Display Table of Contents >>

当前位置:  部署与集成 > WebAPI > 数据源/数据集相关 

数据集新建计算列

复制链接

支持的版本:11.0.1及以后

请求地址

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

请求消息

请求参数

请求参数:xmlData(必填)

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

<info>

<ref>

<type>sql</type>

<path>咖啡中国门店订单数据</path>

</ref>

<calculatedCols>

<col>

<name>计算列-总成本</name>

<type>basic</type>

<calScript>col['销量']*col['成本']</calScript>

</col>

<col>

<name>计算列-级别</name>

<type>sql</type>

<calScript>SUBSTRING_INDEX(col['市场级别'], '市场', 1)</calScript>

</col>

</calculatedCols>

</info>

参数描述

ref(必填):需要添加计算列的数据集。

ref-type(必填):添加计算列的数据集的类型。(仅支持SQL、自服务、数据模型、组合数据集,见附录)。

ref-path(必填):设置参数的数据集的路径。

calculatedCols(必填):新建计算列列表。

calculatedCols-col(必填):新建计算列。

calculatedCols-col-name(必填):新建计算列名称。

calculatedCols-col-type(选填):新建计算列类型。可填值js、sql、basic、mongo、mdx。

calculatedCols-col-calScript(必填):新建计算列脚本。

说明:

calculatedCols-col-calScript中部分特殊字符在传递xmlData中需要转义。例如:

< 转义为 &lt;

> 转义为 &gt;

& 转义为 &amp;

" 转义为 &quot;

' 转义为 &apos;

示例

function addCalculatedColumn() {

       var xml = getXml();

       $.post("http://" + ip + ":" + port + "/" + project + "/api?action=addCalculatedColumn&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>别名或者名称“计算列-总成本”已存在。</message>

</result>

</results>

或者

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

<results>

<result>

   <level>6</level>

   <message>发现不合法的语句:zz</message>

</result>

</results>

结果描述

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

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

message为接口操作结果信息,当level为1的时候,表示保存成功,message信息为保存的数据源的信息。