GetPrxMetaJsPlugin: Operation

The GetPrxMetaJsPlugin operation gets settings of the regular report sheet created using a JS plugin.

Comments

To execute the operation, in the mon field specify regular report instance moniker with the !Sheets!sheet key postfix, and in the tArg field specify sheet settings to be obtained. The regular report instance moniker can be obtained on executing the OpenPrxMeta operation. In the tArg field specify empty values or default values for the fields, which values should be obtained.

Example

Below is the example of getting settings of the sheet created using a JS plugin. The request contains sheet moniker and empty values of the fields, for which the specified settings should be obtained. The response contains the obtained information.

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="">GEMJCGFIGFENFOAEBGOFPOLHGGHEJKBELLCABGHLCFCOJLNN!M!S!PMNHKFJFIGFENFOAENKOBPFBMPBEAOCHEFJCELFBNBEJLDIGK!Sheets!2</mon>

<n />

</tArg>

</GetPrxMetaJsPlugin>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

<n xmlns="">Sheet with plugin</n>

<pluginId xmlns="">PP.Ui.Prx.TestPrxPlugin</pluginId>

</GetPrxMetaJsPluginResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetPrxMetaJsPlugin" : 
  {
   "mon" : "GEMJCGFIGFENFOAEBGOFPOLHGGHEJKBELLCABGHLCFCOJLNN!M!S!PMNHKFJFIGFENFOAENKOBPFBMPBEAOCHEFJCELFBNBEJLDIGK!Sheets!2",
   "tArg" : 
    {
     "k" : "-1",
     "n" : "",
     "pluginId" : ""
    }
  }
}

JSON response:

{
 "GetPrxMetaJsPluginResult" : 
  {
   "k" : "2",
   "n" : "Sheet with plugin",
   "pluginId" : "PP.Ui.Prx.TestPrxPlugin"
  }
}

public static PrxMetaJsPlugin GetPrxMetaJsPlugin(string moniker, string sheetKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetPrxMetaJsPlugin()
    {
        tArg = new PrxMetaJsPlugin()
        {
            pluginId = string.Empty,
            k = uint.MaxValue,
            n = string.Empty
        },
        mon = moniker + "!Sheets!" + sheetKey
    };
    // Get sheet settings
    var result = somClient.GetPrxMetaJsPlugin(tGet);
    return result;
}

GetPrxMetaJsPlugin

Syntax