1.114添加NAS SMB数据源

<< Click to Display Table of Contents >>

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

1.114添加NAS SMB数据源

复制链接

支持的版本:11.0及以后

请求地址

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

请求消息

请求参数

请求参数:xmlData(必填)

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

<info>

<dbsource>

<savepath>api_add_NASSMB</savepath>

<domain>domain</domain>

<rootpath>\\192.168.1.1\</rootpath>

</dbsource>

 <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>订单ID</lcol>

        <vcol>订单ID</vcol>

      </dataset>

    </values>

  </param>

 </params>

</info>

参数描述

savepath(必填):要保存的数据源的名字,在文件夹下,是一个路径,如test/测试数据源。

domain(必填):域。

rootpath(必填):根路径。

设置参数相关参数:

params(选填):数据集中设置的参数集合。

params-param(选填):数据集中设置的参数。

params-param-name(参数中必填):数据集中设置的参数名。

params-param-type(参数中必填):数据集中设置的参数类型,支持填写的类型有string、boolean、float、double、int、short、long、char、byte、date、time、dateTime。

params-param-multiple(参数中选填):参数是否多个值,true表示多个值,false表示单个值、空,默认为false。

params-param-value(参数中选填):如果Multiple为true,对应value为多个值且用逗号分隔;如果Multiple为false,value可以为单个值或空值。

params-param-popup(参数中选填):参数是否弹出,值为true/false,默认为true。

params-param-hide(参数中选填):二次引用是否隐藏,值为true/false,默认为false。

params-param-values(选填):参数可选值,可以为空,也可以为数据集。

params-param-values-dataset(参数可选值中选填):可选值的数据集。

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>参数才生效。

如果两次添加的savepath一致,此方法会覆盖掉之前所添加的数据源。

示例

function saveNASSMBSource() {

   var xml = getXml();

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

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

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