GetPrxMeta

Syntax

PrxMetaResult GetPrxMeta(string mon, PrxMetaArg tArg)

Parameters

mon. Moniker of opened regular report instance.

tArg. Operation execution parameters.

Description

The GetPrxMeta operation gets regular report metadata.

Comments

The operation gets settings of various regular report elements. To execute the operation, in the mon field specify moniker of opened regular report instance, and in the tArg field specify parameters for getting metadata.

The moniker can be obtained on executing the OpenPrxMeta operation.

In the tArg.meta field set empty values or default values for the fields, which values should be obtained. Specify one element for collections. To get information about a specific regular report element, specify its key in metadata. If -1 is specified as a key value, information about all elements of this type is obtained.

Example

Below is the example of getting information about regular report sheets. The request contains moniker for working with regular report and a list of the fields, which values should be obtained. The response contains requested 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">
<GetPrxMeta xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1</mon>
<tArg xmlns="">
<meta>
<sheets>
<its>
<it>
  <k>-1</k>
  <n />
  <type>Table</type>
  </it>
  </its>
  </sheets>
  </meta>
  </tArg>
  </GetPrxMeta>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetPrxMetaResult 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>S1!M!S!P1</id>
  </id>
<meta xmlns="">
<sheets>
<its>
<it>
  <k>1</k>
  <n>Data</n>
  <type>Table</type>
  </it>
  </its>
  </sheets>
  </meta>
  </GetPrxMetaResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetPrxMeta" :
{
"mon" : "S1!M!S!P1",
"tArg" :
{
"meta" :
{
"sheets" :
{
"its" :
{
"it" :
[
{
"k" : "-1",
"n" : "",
"type" : "Table"
}
]
}
}
}
}
}
}

JSON response:

{
"GetPrxMetaResult" :
{
"id" :
{
"id" : "S1!M!S!P1"
},
"meta" :
{
"sheets" :
{
"its" :
{
"it" :
[
{
"k" : "1",
"n" : "Data",
"type" : "Table"
}
]
}
}
}
}
}
public static PrxMetaResult GetPrxSheets(string moniker)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tGet = new GetPrxMeta()
{
tArg = new PrxMetaArg()
{
meta = new PrxMetaData()
{
sheets = new PrxMetaSheets()
{
its = new PrxMetaSheet[1]
{
new PrxMetaSheet() { k = ulong.MaxValue, n= "", type = PrxSheetType.Table }
}
}
}
},
mon = moniker
};
//Get information about report sheets
var result = somClient.GetPrxMeta(tGet);
return result;
}

See also:

Working with Regular Reports