请求地址

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

请求消息

请求参数

请求参数：xmlData（必填）

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

<info>

 <ref>

 <type>sql</type>

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

 </ref>

 <params>

     <param>

        <name>Short</name>

        <type>int</type>

        <direction>IN</direction>

        <multiple>true</multiple>

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

        <hide>true</hide>

        <popup>false</popup>

        <values>

           <dataset>

              <type>sql</type>

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

              <lcol>col1</lcol>

              <vcol>col2</vcol>

           </dataset>  

        </values>  

        </param>

 </params>

</info>

参数描述

•ref（必填）：需要设置参数的数据集。

•ref-type（必填）：设置参数的数据集的类型。

•ref-path（必填）：设置参数的数据集的路径。

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

•params-param（选填）：设置的参数。

•params-param-name（必填）：参数名。

•params-param-type（必填）：参数类型。

•params-param-direction（必填）：参数方向。

•params-param-hide（参数中选填）：二次引用是否隐藏，值为true/false，默认为false。

•params-param-popup（选填）：参数是否弹出。

•params-param-multiple（选填）：参数是否多个值，true表示多个值，false表示单个值、空。

•params-param-value（选填）：如果Multiple为true，对应value为多个值且用逗号分隔；如果Multiple为false，value可以为单个值或空值。

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

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

•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时输入正整数值。

➢说明：

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

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

示例

function setQueryParameter() {

       var xml = getXml();

       $.post("http://" + ip + ":" + port + "/" + project + "/api?action=setQueryParameter&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，直接parse即可。

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

•message为接口操作结果信息。