DashboardVisualizerExport: Operation

Result DashboardVisualizerExport(string mon, DashboardVisualizerExportSettings tArg)

Parameters

Description

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance with the !Visualizers postfix, and in the tArg field specify key of exported visualizer, export format, and if required, visualization settings. The moniker can be obtained on executing the OpenDashboard operation.

During the export, the file is saved to BI server storage. After executing the operation, the storeId field contains moniker of the created file. This moniker can be sent to the GetBin operation for loading file to the client computer.

Example

Below is the example of visualizer export to external file. The request contains moniker for working with visualizer, key of exported visualizer, and export format. The response contains moniker of the obtained file in BI server storage.

SOAP JSON C#

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">

<mon xmlns="">NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI!Visualizers</mon>

</tArg>

</DashboardVisualizerExport>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<id>NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI!Bin!0</id>

</storeId>

</DashboardVisualizerExportResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "DashboardVisualizerExport" : 
  {
   "mon" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI!Visualizers",
   "tArg" : 
    {
     "k" : "1",
     "format" : "xlsx"
    }
  }
}

JSON response:

{
 "DashboardVisualizerExportResult" : 
  {
   "format" : "xlsx",
   "storeId" : 
    {
     "id" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI!Bin!0"
    },
   "warnings" : ""
  }
}

public static ExportData DashboardVisualizerExport(string moniker, uint visKey, string exportFormat)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tExp = new DashboardVisualizerExport()
    {
        tArg = new DashboardVisualizerExportSettings()
        {
            k = visKey,
            format = exportFormat
        },
        // Moniker for working with information panel visualizers
        mon = moniker + "!Visualizers"
    };
    // Export visualizer
    var result = somClient.DashboardVisualizerExport(tExp);
    return result;
}

DashboardVisualizerExport

Syntax