请求地址

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

请求消息

请求参数

请求参数：xmlData（必填）

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

<info>

<path>测试流式数据集</path>

<queryId>testQueryId</queryId>

<charset>UTF-8</charset>

<note>备注</note>

<kafkaDataSource>

   <enabled>true</enabled>

   <dbsource>kafka</dbsource>

   <topic>kafka</topic>

   <interval>1</interval>

</kafkaDataSource>

<cols>

<col>

<name>create_date</name>

<type>date</type>

<alise>创建时间</alise>

<isDim>true</isDim>

</col>

<col>

<name>产品种类</name>

<type>string</type>

<alise></alise>

<isDim>true</isDim>

</col>

<col>

<name>利润</name>

<type>double</type>

<alise></alise>

<isDim>false</isDim>

</col>

<datecol>

<basecol>create_date</basecol>

<level>day</level>

<alias>day1</alias>

</datecol>

<hiers>

<hiers-name>测试1</hiers-name>

<basecol>create_date</basecol>

<datecol>

<level>year</level>

<alias>year1</alias>

</datecol>

<datecol>

<level>month</level>

<alias>month11</alias>

</datecol>

</hiers>

</cols>

<params>

<param>

<name>Short</name>

<type>int</type>

<multiple>true</multiple>

<value>1,2,3,4</value>

<popup>false</popup>

<hide>true</hide>

<values>

<dataset>

<type>sql</type>

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

<lcol>col1</lcol>

<vcol>col2</vcol>

</dataset>

</values>

</param>

</params>

</info>

参数描述

•path（必填）：数据集的全路径。如果该路径不存在流式数据集，则创建流式数据集，否则修改该路径的数据集。

•queryId（必填）：流式数据集ID。

•charset（选填）：编码类型，目前支持的编码类型有UTF-8、GBK。默认UTF-8。

•note（选填）：数据集的备注。

•kafkaDataSource（选填）：拉取kafka数据应用到流式数据集设置。

•kafkaDataSource-enabled（选填）：是否开启kafka拉取任务。

•kafkaDataSource-dbsource（选填）：填写kafka数据源。kafkaDataSource-enabled为true时必填。

•kafkaDataSource-topic（选填）：将要拉取kafka的topic。kafkaDataSource-enabled为true时必填。

•kafkaDataSource-interval（选填）：执行拉取作业的时间间隔，整数，单位为秒，最大值为100000，超过最大值时设置为最大值。kafkaDataSource-enabled为true时必填。

•cols（选填）： 创建流式数据集数据列信息，以及定义列别名、创建日期列与日期层次。

•cols-col（选填）：定义数据列。

•cols-col-name（必填）：列名（不区分大小写）。

•cols-col-type（必填）：列类型。

列类型可填值

float : 单精度浮点数

double : 双精度浮点数

char : 字符

string : 字符串

byte : 字节

boolean : 布尔

integer : 整数

date : 日期

time : 时间

dateTime : 时间戳

short : 短整数

long : 长整数

decimal : 高精度

•cols-col-alias（选填）：列别名。如果要取消列的别名，不写该节点即可

•cols-col-isDim（选填）：设置此列是否为维度列，true为维度列，false为度量列。如果接口中定义了此列的文件夹，以文件夹的定义优先；接口中新建的日期列不支持设置维度/度量列，按产品通用逻辑默认为维度列。

•datecol（选填）：日期列。

•datecol-basecol（必填）：日期列基于的列，需要选择日期类型的列。

•datecol-level（datecol中必填）：日期列的层次，当前支持输入的值包括dateyear、quarter、 month、 week、 day、 hour、minute、second、fiveminute、 year、 quarterpart、monthpart、weekpart、daypart、hourpart、minutepart、secondpart、 weekday。

•datecol-alias（选填）：日期列的别名，参数值为空时视为取消列的别名。

•hiers（选填）：日期层次。

•hiers-name（选填）：日期层次的名称。

•hiers-basecol（必填）：新建日期层次基于的列，需要选择日期类型的列。

•hiers-datecol（日期层次中必填）：新建日期层次中的日期列，

•hiers-datecol-level（选填）：新建日期层次列的层次，当前支持输入的值包括dateyear、 quarter、 month、week、 day、hour、 minute、 second、fiveminute、year、 quarterpart、monthpart、 weekpart、 daypart、 hourpart、minutepart、secondpart、 weekday。

•hiers-datecol-alias（选填）：新建日期层次列的别名，参数值为空时视为取消列的别名。

设置参数相关的参数：

•params（选填）：数据集设置的参数集合。

•params-param（在param中选填）：数据集中设置的参数。

•params-param-name（在param中必填）：数据集中设置的参数名称。

•params-param-type（在param中必填）：数据集中设置的参数类型，支持填写的类型有string、boolean、float、double、int、short、long、char、byte、date、time、dateTime。

•params-param-multiple（在param中选填），数据集中参数设置为单个、空、多个值，默认为false，即参数为单个值、空；输入为true时参数为多个值，以英文逗号进行分隔。

•params-param-value（在param中选填）：数据集中给参数的默认赋值，不填写或值为空视为将参数默认值置空。

•params-param-popup（在param中选填）：参数是否弹出，值为true、false，如果不填或为空默认为true。

•params-param-hide（在param中选填）：二次引用是否隐藏，值为true、false，如果不填或为空默认为false。

•params-param-values（在param中选填）：参数可选值，可以为空，也可以为数据集。

•params-param-values-dataset（在param中可选值中选填）：可选值的数据集。

•params-param-values-dataset-type（可选值数据集中必填）：数据集的类型，目前支持的类型为sql、mongo、excel、composite、cloud、embed、custom、data_flow、mdx、neo4j、restful、stream、flowreplcaequery。

•params-param-values-dataset-path（可选值数据集中必填）：数据集的全路径。

•params-param-values-dataset-vcol（可选值数据集中必填）：参数可选值来自数据集哪个列。

•params-param-values-dataset-lcol（选填）：参数可选值的标签来自数据集哪个列。

•params-param-values-dataset-aggregation（选填）：动态值的聚合函数类型，包括Sum，Avg，Max，Min，Count，ApproximateCount，DistinctCount，Correlation，Covariance，Median，Mode，PopulationStandardDeviation，PopulationVariance，Product，PthPercentile，Quartile，Range，StandardDeviation，StandardError，SumSQ，SumWT，Variance，WeightAvg。

••params-param-values-dataset-with（选填）：动态值的聚合函数类型参数，当params-param-values-dataset-aggregation值为Correlation、Covariance、SumWT、WeightAvg时，输入数据集中的列名；params-param-values-dataset-aggregation值为PthPercentile、Quartile时输入正整数值。

➢说明：

•当且仅当<multiple>为false，<popup>为false，<value>为空，<values>不为空时，<aggregation>和<with>参数才有意义。

•当且仅当<aggregation>为Correlation、Covariance、PthPercentile、Quartile、SumWT、WeightAvg时，<with>参数才生效。

示例

function saveStreamQuery() {

   var xml = getXml();

   $.post(

       "http://" + ip + ":" + port + "/" + project + "/api?action=saveStreamQuery&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>文件夹不能为空：path</message>

  </result>

</results>

结果描述

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

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

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