Query Data Set Column Filter Settings

<< Click to Display Table of Contents >>

Current:  System Integration > WebAPI 

Query Data Set Column Filter Settings

Previous pageReturn to chapter overviewNext page

Version: 9.1

Request address

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

Request message

Request parameter

required parameter:xmlData (required)

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

<info>

 <type>sql</type>  

 <path>test</path>  

</info>

parametric description

1) type (required): the type of data set.

2) path (required): the path of the data set.

Sample

function getQueryColumnFilter() {

        var xml = getXml();

        $.post("http://" + ip + ":" + port + "/" + project + "/api?action=getQueryColumnFilter&token=xxxx",

           {xmlData : xml},

           function(result) {        

              writeXml(result);

           });

     }

Response message

Response result

 

1) Successful operation

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

<result>

<query>

<cols>

<col type="column type">column name/alias of column</col>

</cols>

<columnFilters>

<columnFilter>

<type>whitelist</type>

<col type="string">date</col>

<identity>

<ref>

<name>admin</name>

<type>user</type>

</ref>

</identity>

</columnFilter>

</columnFilters>

</query>

</result>

2) Operation failed

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

<results>

<result>

<level>6</level>

<message>\Yonghong\bihome\query\test.sqry (The system cannot find the specified file.)</message>

</result>

</results>

Result description

The response result information is xml. direct parse.

1) Level return type, different values represent different return status, see appendix.

2) Message is the interface operation result information.