GetDashboardMeta

Syntax

DashboardMetaResult GetDashboardMeta(string mon, DashboardMetaArg tArg)

Parameters

mon. Moniker of opened information panel instance.

tArg. Operation execution parameters.

Description

The GetDashboardMeta operation gets information panel metadata.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance, and in the tArg.meta field specify empty values or default values for the fields with metadata, which values should be obtained. The moniker can be obtained on executing the OpenDashboard operation.

The operation results in the obtained information panel metadata.

Example

Below is the example of getting a list of data sources and information panel visualization settings. The request contains moniker of opened information panel instance and the list of obtained fields. The response contains the obtained information.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetDashboardMeta xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI</mon>
<tArg xmlns="">
<meta>
<sources>
<its>
<it>
  <k>-1</k>
<descr>
  <i />
  <n />
  <k>-1</k>
  <c>-1</c>
  </descr>
  <supportRemoveFields>true</supportRemoveFields>
  </it>
  </its>
  </sources>
  <viewSettings />
  </meta>
  </tArg>
  </GetDashboardMeta>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDashboardMetaResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id xmlns="">
  <id>NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI</id>
  </id>
<meta xmlns="">
<sources>
<its>
<it>
  <k>1</k>
<descr ds="" isShortcut="0" isLink="0" ver="23" hf="0">
  <i>CUBE_SEP</i>
  <n>Cube of socio-economic indicators</n>
  <k>10206</k>
  <c>1281</c>
  <p>9698</p>
  <h>0</h>
  <hasPrv>0</hasPrv>
  <ic>0</ic>
  <trackElementDependents>0</trackElementDependents>
  </descr>
  <supportRemoveFields>0</supportRemoveFields>
  </it>
  </its>
  </sources>
  <viewSettings>{"version":"2","isDataAndFieldsVisible":true,"isSettingsVisible":false,"zoom":0.75,"visibleArea":{"x":-200.17760487144778,"y":-93.49644790257105,"height":838,"width":771,"offsetX":560,"offsetY":48}}</viewSettings>
  </meta>
  </GetDashboardMetaResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetDashboardMeta" :
{
"mon" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI",
"tArg" :
{
"meta" :
{
"sources" :
{
"its" :
{
"it" :
[
{
"k" : "-1",
"descr" :
{
"i" : "",
"n" : "",
"k" : "-1",
"c" : "-1"
},
"supportRemoveFields" : "true"
}
]
}
},
"viewSettings" : ""
}
}
}
}

JSON response:

{
"GetDashboardMetaResult" :
{
"id" :
{
"id" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI"
},
"meta" :
{
"sources" :
{
"its" :
{
"it" :
[
{
"k" : "1",
"descr" :
{
"@ds" : "",
"@isShortcut" : "0",
"@isLink" : "0",
"@ver" : "23",
"@hf" : "0",
"i" : "CUBE_SEP",
"n" : "Cube of socio-economic indicators",
"k" : "10206",
"c" : "1281",
"p" : "9698",
"h" : "0",
"hasPrv" : "0",
"ic" : "0",
"trackElementDependents" : "0"
},
"supportRemoveFields" : "0"
}
]
}
},
"viewSettings" : "{"version":"2","isDataAndFieldsVisible":true,"isSettingsVisible":false,"zoom":0.75,"visibleArea":{"x":-200.17760487144778,"y":-93.49644790257105,"height":838,"width":771,"offsetX":560,"offsetY":48}}"
}
}
}
public static DashboardMetaResult GetDashboardMeta(string moniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetDashboardMeta()
{
tArg = new DashboardMetaArg()
{
meta = new DashboardMetaData()
{
sources = new DashboardSources()
{
its = new DashboardSource[]
{
new DashboardSource()
{
k = uint.MaxValue,
descr = new Od()
{
c = uint.MaxValue,
i = string.Empty,
k = uint.MaxValue,
n = string.Empty
},
supportRemoveFields = true
}
}
},
viewSettings = string.Empty
}
},
// Moniker of opened information panel instance
mon = moniker
};
// Get information about information panel
var result = somClient.GetDashboardMeta(tGet);
return result;
}

See also:

Working with Information Panel