<< Click to Display Table of Contents >> 1.93添加RESTful数据源复制链接 |
支持的版本:10.0及以后
请求地址 |
http://ip:port/bi/api?action=saveRESTfulSource&token=xxxx |
|
请求消息 |
请求参数 |
请求参数:xmlData(必填) <?xml version="1.0" encoding="utf-8"?> <info> <dbsource> <savepath>测试数据源</savepath <requestType>POST</requestType> <url>***</url> <auth>1</auth> <user>admin</user> <pass>admin</pass> <encode>UTF-8</encode> <params> <param> <name>***</name> <type>int</type> <multiple>true</multiple> <value>***</value> <popup>false</popup> <hide>true</hide> </param> <param> <name>***</name> <type>int</type> <multiple>true</multiple> <value>***</value> <popup>false</popup> <hide>true</hide> </param> </params> </dbsource> </info> |
参数描述 |
•savepath(必填):要保存的数据源的名字,在文件夹下,是一个路径,如test/测试数据源。 •requestType(必填):请求类型,支持GET、POST。 •url(必填):url链接。 •auth(必填):认证方式,0为无身份认证,1为用户名和密码。 •user(选填):连接数据库的用户名,如果认证方式为1,必填。 •pass(选填):连接数据库的密码。 •encode(必填):编码类型,目前支持的编码类型有UTF-8、GBK、ISO-8859-1、GB2312。 •params(选填):数据源设置的参数集合,覆盖同名数据源时旧的参数集合也被覆盖。 •params-param(选填):数据源中需要设置的参数。 •params-param-name(必填):数据源中需要设置的参数名称。 •params-param-type(必填):数据源中需要设置的参数类型,包括string、boolean、float、double、int、short、long、char、byte、date、time、dateTime。 •params-param-multiple(选填):数据源中参数设置为单个、空、多个值,默认为false,即参数为单个值、空;输入为true时,参数为多个值,以英文逗号进行分隔。 •params-param-value(选填):数据源中给参数的默认赋值,不填写或值为空参数默认值置空。 •params-param-popup(选填):参数是否弹出,值为true、false,如果不填或为空默认为true。 •params-param-hide(选填):二次引用是否隐藏,值为true、false,如果不填或为空默认为false。 •如果两次添加的savepath一致,此方法会覆盖掉之前所添加的数据源。 |
|
示例 |
function addDbSource() { var xml = getXml(); $.post("http://" + ip + ":" + port + "/" + project + "/api?action=saveDbSource&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信息为保存的数据源的信息。 |