获取数据集元数据

<< Click to Display Table of Contents >>

当前位置:  »当前无上一级«

获取数据集元数据

复制链接

支持的版本:11.0.2及以后

请求地址

http://ip:port/bi/api?action=getQueryMetaData

请求消息

请求参数

token(必填)

token_parameter_zoom48

xmlData(必填)

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

<info>

<type>sql</type>

<path>coffee</path>

</info>

参数描述

type(必填):数据集的类型。(见附录

path(必填):数据集的路径。

示例

function getQueryMetaData() {

   var xml = getXml();

   $.post(

       "http://" + ip + ":" + port + "/" + project + "/api?action=getQueryMetaData",

       { xmlData: xml },

       function(result) {

           writeXml(result);

       }

   );

}

响应消息

响应结果

操作成功

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

<result>

 <query>

   <folders/>

   <hiers/>

   <cols>

     <col>

       <type>string</type>

       <isDim>true</isDim>

       <name>MARKET SIZE</name>

       <alias></alias>

       <remark></remark>

       <format></format>

       <dataMask></dataMask>

       <visibile>false</visibile>

       <columnFilter>

         <type>

         </type>

         <identity>

           <ref>

             <name>

             </name>

             <type>

             </type>

           </ref>

         </identity>

       </columnFilter>

     </col>

     <col>

       <type>string</type>

       <isDim>true</isDim>

       <name>PRODUCT TYPE</name>

       <alias></alias>

       <remark></remark>

       <format></format>

       <dataMask></dataMask>

       <visibile>false</visibile>

       <columnFilter>

         <type>

         </type>

         <identity>

           <ref>

             <name>

             </name>

             <type>

             </type>

           </ref>

         </identity>

       </columnFilter>

     </col>

     <col>

       <type>date</type>

       <isDim>true</isDim>

       <name>DATE</name>

       <alias></alias>

       <remark></remark>

       <format></format>

       <dataMask></dataMask>

       <visibile>false</visibile>

       <columnFilter>

         <type>

         </type>

         <identity>

           <ref>

             <name>

             </name>

             <type>

             </type>

           </ref>

         </identity>

       </columnFilter>

     </col>

     <col>

       <type>int</type>

       <isDim>true</isDim>

       <name>ID</name>

       <alias></alias>

       <remark></remark>

       <format></format>

       <dataMask></dataMask>

       <visibile>false</visibile>

       <columnFilter>

         <type>

         </type>

         <identity>

           <ref>

             <name>

             </name>

             <type>

             </type>

           </ref>

         </identity>

       </columnFilter>

     </col>

     <col>

       <type>int</type>

       <isDim>false</isDim>

       <name>SALES</name>

       <alias></alias>

       <remark></remark>

       <format></format>

       <dataMask></dataMask>

       <visibile>false</visibile>

       <columnFilter>

         <type>

         </type>

         <identity>

           <ref>

             <name>

             </name>

             <type>

             </type>

           </ref>

         </identity>

       </columnFilter>

     </col>

     <col>

       <type>int</type>

       <isDim>false</isDim>

       <name>COGS</name>

       <alias></alias>

       <remark></remark>

       <format></format>

       <dataMask></dataMask>

       <visibile>false</visibile>

       <columnFilter>

         <type>

         </type>

         <identity>

           <ref>

             <name>

             </name>

             <type>

             </type>

           </ref>

         </identity>

       </columnFilter>

     </col>

   </cols>

 </query>

</result>

操作失败

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

<results>

   <result>

       <level>6</level>

       <message>数据集“coffee”不存在。</message>

   </result>

</results>

结果描述

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

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

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