Getting Information about Regular Report Sheets

Below is the example of using the GetPrxMd operation to get information about all sheets of a regular report. The request contains moniker of opened regular report instance and a pattern indicating whether information about the sheets must 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">
<GetPrxMd xmlns="http://www.fsight.ru/PP.SOM.Som">
<tPrx xmlns="">
  <id>S1!M!S!P1</id>
  </tPrx>
<tArg xmlns="">
<pattern>
  <obInst>true</obInst>
<sheet>
  <pageSettings>true</pageSettings>
  </sheet>
  <sheets>Get</sheets>
  </pattern>
  </tArg>
  </GetPrxMd>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetPrxMdResult 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="">
<obInst>
<obDesc ds="" isShortcut="0" isLink="0" ver="0" hf="0">
  <i>REPORT_1</i>
  <n>Regular report</n>
  <k>6334</k>
  <c>2562</c>
  <p>6333</p>
  <h>0</h>
  <hasPrv>0</hasPrv>
  <ic>0</ic>
  <isPermanent>1</isPermanent>
  <isTemp>0</isTemp>
  </obDesc>
  <openArgs />
  </obInst>
<sheets>
  <active>0</active>
<its>
<it>
  <k>1</k>
  <id>Sheet1</id>
  <n>Sheet1</n>
  <vis>1</vis>
  <type>Table</type>
  <isActive>1</isActive>
<pageSettings>
<paperSize>
  <width>210000</width>
  <height>297000</height>
  <units>Mkm</units>
  </paperSize>
<margins>
  <left>10000</left>
  <top>10000</top>
  <right>10000</right>
  <bottom>10000</bottom>
  <units>Mkm</units>
  </margins>
  <paperFormat>A4</paperFormat>
  <paperOrientation>Portrait</paperOrientation>
  <centerHorizontal>0</centerHorizontal>
  <centerVertical>0</centerVertical>
  <printHyperlinks>0</printHyperlinks>
  <blackAndWhite>0</blackAndWhite>
  <printOrder>FromTopToBottom</printOrder>
<scale>
  <value>1</value>
  <fitToPages>0</fitToPages>
  <pageWidth>-1</pageWidth>
  <pageHeight>-1</pageHeight>
  </scale>
  <startPageNumber>0</startPageNumber>
  <useSheetPageCount>0</useSheetPageCount>
  </pageSettings>
<dataChange>
  <isDataChanged>0</isDataChanged>
  </dataChange>
  </it>
<it>
  <k>2</k>
  <id>Document1</id>
  <n>Document1</n>
  <vis>1</vis>
  <type>Document</type>
  <isActive>0</isActive>
<pageSettings>
<paperSize>
  <width>210060</width>
  <height>296933</height>
  <units>Mkm</units>
  </paperSize>
<margins>
  <left>25400</left>
  <top>25400</top>
  <right>25400</right>
  <bottom>25400</bottom>
  <units>Mkm</units>
  </margins>
  <paperFormat>A4</paperFormat>
  <paperOrientation>Portrait</paperOrientation>
  <centerHorizontal>0</centerHorizontal>
  <centerVertical>0</centerVertical>
  <printHyperlinks>0</printHyperlinks>
  <blackAndWhite>0</blackAndWhite>
  <printOrder>FromTopToBottom</printOrder>
<scale>
  <value>1</value>
  <fitToPages>0</fitToPages>
  <pageWidth>-1</pageWidth>
  <pageHeight>-1</pageHeight>
  </scale>
  <startPageNumber>0</startPageNumber>
  <useSheetPageCount>0</useSheetPageCount>
  </pageSettings>
  </it>
  </its>
  </sheets>
<dataChange>
  <isDataChanged>0</isDataChanged>
  </dataChange>
  </meta>
  </GetPrxMdResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetPrxMd" :
{
"tPrx" :
{
"id" : "S1!M!S!P1"
},
"tArg" :
{
"pattern" :
{
"obInst" : "true",
"sheet" :
{
"pageSettings" : "true"
},
"sheets" : "Get"
}
}
}
}

JSON response:

{
"GetPrxMdResult" :
{
"id" :
{
"id" : "S1!M!S!P1"
},
"meta" :
{
"obInst" :
{
"obDesc" :
{
"@ds" : "",
"@isShortcut" : "0",
"@isLink" : "0",
"@ver" : "0",
"@hf" : "0",
"i" : "REPORT_1",
"n" : "Regular report",
"k" : "6334",
"c" : "2562",
"p" : "6333",
"h" : "0",
"hasPrv" : "0",
"ic" : "0",
"isPermanent" : "1",
"isTemp" : "0"
},
"openArgs" : ""
},
"sheets" :
{
"active" : "0",
"its" :
{
"it" :
[
{
"k" : "1",
"id" : "Sheet1",
"n" : "Sheet1",
"vis" : "1",
"type" : "Table",
"isActive" : "1",
"pageSettings" :
{
"paperSize" :
{
"width" : "210000",
"height" : "297000",
"units" : "Mkm"
},
"margins" :
{
"left" : "10000",
"top" : "10000",
"right" : "10000",
"bottom" : "10000",
"units" : "Mkm"
},
"paperFormat" : "A4",
"paperOrientation" : "Portrait",
"centerHorizontal" : "0",
"centerVertical" : "0",
"printHyperlinks" : "0",
"blackAndWhite" : "0",
"printOrder" : "FromTopToBottom",
"scale" :
{
"value" : "1",
"fitToPages" : "0",
"pageWidth" : "-1",
"pageHeight" : "-1"
},
"startPageNumber" : "0",
"useSheetPageCount" : "0"
},
"dataChange" :
{
"isDataChanged" : "0"
}
},
{
"k" : "2",
"id" : "Document1",
"n" : "Document1",
"vis" : "1",
"type" : "Document",
"isActive" : "0",
"pageSettings" :
{
"paperSize" :
{
"width" : "210060",
"height" : "296933",
"units" : "Mkm"
},
"margins" :
{
"left" : "25400",
"top" : "25400",
"right" : "25400",
"bottom" : "25400",
"units" : "Mkm"
},
"paperFormat" : "A4",
"paperOrientation" : "Portrait",
"centerHorizontal" : "0",
"centerVertical" : "0",
"printHyperlinks" : "0",
"blackAndWhite" : "0",
"printOrder" : "FromTopToBottom",
"scale" :
{
"value" : "1",
"fitToPages" : "0",
"pageWidth" : "-1",
"pageHeight" : "-1"
},
"startPageNumber" : "0",
"useSheetPageCount" : "0"
}
}
]
}
},
"dataChange" :
{
"isDataChanged" : "0"
}
}
}
}
public static GetPrxMdResult GetPrxMd(PrxId moniker)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tArg = new GetPrxMd()
{
tArg = new GetPrxMdArg()
{
pattern = new PrxMdPattern()
{
sheets = ListOperation.Get,
sheet = new PrxSheetPattern()
{
pageSettings = true
}
}
},
tPrx = moniker
};
//Get metadata
var result = somClient.GetPrxMd(tArg);
return result;
}

See also:

GetPrxMd