<< Click to Display Table of Contents >> 1.95导出数据集为文件流复制链接 |
支持的版本:10.1及以后
请求地址 |
http://ip:port/bi/api?action=downloadQuery&token=xxxx |
|
请求消息 |
请求参数 |
请求参数:xmlData(必填) <?xml version="1.0" encoding="UTF-8"?> <info> <user>admin</user> <qryPath>咖啡中国市场销售数据</qryPath> <qryType>sql</qryType> <fileType>csv</fileType> <params> <name>Short</name> <type>int</type> <multiple>true</multiple> <value>1,2,3,4</value> </params> </info> |
参数描述 |
•user(选填):执行导出数据集用户的用户名。默认为调用API使用token的用户自身,只有此用户为admin用户或admin_role角色时支持选择其他用户,其他用户或角色只能输入自己。 •qryPath(必填):数据集的全路径。 •qryType(必填):数据集的类型,包括sql、mongo、excel、composite、cloud、embed、custom、data_flow、restful。 •fileType(必填):文件流的类型,包括excel、csv两种。 •params(选填):设置可能使用的参数集合。 •param(选填):设置可能使用的参数。 •params-param-name(选填):数据集中需要设置的参数的名称,在param中必填。 •params-param-value(选填):参数赋值,不填写或值为空视为将参数置空。 |
|
示例 |
function downloadQuery() { var xml = getXml(); $.post("http://" + ip + ":" + port + "/" + project + "/api?action=downloadQuery&token=xxxx", { xmlData : xml }, function( result) { writeXml(result) }); } |
|
响应消息 |
响应结果 |
•操作成功,返回文件流,可进行保存操作。 •操作失败,如用户无权限访问目标路径的数据集。 <?xml version="1.0" encoding="UTF-8"?> <results> <result> <level>6</level> <message>用户“test”无权访问“api/coffee”。</message> </result> </results> |
结果描述 |
响应结果信息为xml,直接parse即可。 •level 返回类型,不同数值代表不同返回状态,见附录。 •message为接口操作结果信息 |