请求地址

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

请求消息

请求参数

请求参数：xmlData（必填）

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

<info>

  <path>testrestful</path>

  <dbsource>restful1</dbsource>

<reqParams>

   <param>

    <key>***</key>

    <value>***</value>

    </param>

   <param>

    <key>***</key>

    <value>***</value>

    </param>

</reqParams>

<reqHeaders>

   <param>

    <key>***</key>

    <value>***</value>

    </param>

   <param>

    <key>***</key>

    <value>***</value>

    </param>

</reqHeaders>

<reqBody>

***

</reqBody>

  <json>***</json>

  <material>false</material>

  <fullData>false</fullData>

<forbidDownload>false</forbidDownload>

   <note>备注</note>

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

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

•dbsource（必填）：使用的数据源路径，需要使用RESTful数据源。

•params（选填）：请求参数。

•headers（选填）：请求头。

•body（选填）：请求体。

•json（选填）：json查询语句。

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

•fulldata：是否设置为全量数据，值为true、false，默认为false。

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

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

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

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

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

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

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

➢说明：

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

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

示例

function saveRESTfulQuery() {

   var xml = getXml();

   $.post("http://" + ip + ":" + port + "/" + project + "/api?action=saveRESTfulQuery&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>请输入合法的restful数据源路径</message>

  </result>

</results>

结果描述

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

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

•message为接口操作结果信息