请求地址

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

请求消息

请求参数

请求参数：xmlData（必填）

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

<info>

 <path>咖啡中国市场销售数据</path>

 <dbsource>Demo Data_zhCN</dbsource>

 <sql>SELECT * from 咖啡中国市场销售数据</sql>

 <material>false</material>

 <sqlParse>false</sqlParse>

 <fullData>false</fullData>

 <forbidDownload>false</forbidDownload>

 <cols>

     <col>

         <name>update_date</name>

         <alias>更新时间2</alias>

     </col>

     <col>

         <name>create_date</name>

         <alias>创建时间2</alias>

     </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>

         <direction>IN</direction>

         <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（必填）：数据集的路径。如果该路径不存在, 则创建sql数据集。否则修改该路径的数据集。

•dbsource（必填）：数据源路径。

•sql（必填）：sql语句。

•material（选填）： 物化查询或者释放物化查询。值只能是true和false。

•sqlparse：是否支持无验证的SQL解析器，值为true/false。

•fulldata：是否添加SQL数据集的全量数据，值为true/false。

•forbidDownload（选填）：是否禁止下载，值为true/false，默认为false。

•cols（选填）： 需要定义别名的列集合。如果某列没有设置别名，则按照修改前的别名设置该列的别名。

•cols-col（选填）：定义列别名 。

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

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

•datecol（选填）：日期列。

•datecol-basecol（日期列中必填）：日期层次基于的列。

•datecol-level（日期列中必填）：日期层次列的层次。

•datecol-alias（选填）：日期层次列的别名，为空时把别名置空，不填则。

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

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

•hires-basecol（日期层次中必填）：新建日期层次基于的列。

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

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

•hiers-datecol-alias（选填）：新建日期层次列的别名。

9.4新增在添加SQL数据集时可以设置参数功能，设置参数相关参数：

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

•params-param（参数集合中必填）：设置的参数

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

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

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

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

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

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

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

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

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

•params-param-values-dataset-lcol（可选值数据集中必填）：数据集的标签。

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

示例

function saveSqlQuery() {

  var xml = getXml();

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

    { xmlData : xml }, function( result) {

          writeXml(result)

  });

}

响应消息

响应结果

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

<results>

  <result>

      <level>1</level>

      <message>Save Success</message>

  </result>

</results>

结果描述

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

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

•message为接口操作结果信息