Request address

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

Request message

Request parameter

required parameter:xmlData (required)

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

<info>

  <dbpath>test</dbpath>

</info>

parametric description

Parameter is node information :

1)dbpath(required)：dashboard path(example is the test dashboard in the root directory)

Sample

function getElems() {

        var xml = getXml();

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

           {xmlData : xml},

           function(result) {

           writeXml(result);

        });

     }

Response message

Response result

1）Successful operation

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

<elems>

  <elem><name>Gauge1</name><type>Gauge</type></elem>

  <elem><name>FilterGroup1</name><type>FilterGroup</type></elem>

  <elem><name>FormTable1</name><type>FormTable</type></elem>

  <elem><name>Text1</name><type>Text</type></elem>

 <elem><name>Commit1</name><type>Commit</type></elem>

  <elem><name>Image1</name><type>Image</type></elem>

  <elem><name>FilterList1</name><type>FilterList</type></elem>

  <elem><name>ListParam1</name><type>ListParam</type></elem>

  <elem><name>FilterTree1</name><type>FilterTree</type></elem>

  <elem><name>TextParam1</name><type>TextParam</type></elem>

  <elem><name>Tab1</name><type>Tab</type></elem>

  <elem><name>Chart1</name><type>Chart</type></elem>

  <elem><name>Table1</name><type>Table</type></elem>

  <elem><name>Exploded1</name><type>Exploded</type></elem>

  <elem><name>Calendar1</name><type>Calendar</type></elem>

  <elem><name>Pivot1</name><type>Pivot</type></elem>

  <elem><name>ComboParam1</name><type>ComboParam</type></elem>

  <elem><name>Range1</name><type>Range</type></elem>

</elems>

2）Operation failure

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

<results>

  <result>

     <level>6</level>

     <message>D:\bihome\dashboard\test1.db(the system could not find the specified file.)</message>

  </result>

</results>

Result description

Elems: a collection of all dashboard elements.

Elem: information for a specific component in the instrument panel.

Elem-name: the name of the component.

Elem-type: type of component (the successful example above contains all component types)