GetPivotHeaderMetaData

Syntax

PivotHeader GetPivotHeaderMetaData(string mon, PivotHeader tArg)

Parameters

mon. Moniker for working with data slice header.

tArg. Parameters for getting information about slice header.

Description

The GetPivotHeaderMetaData operation gets information about data slice header.

Comments

The operation gets various settings specified for header.

To execute the operation, in the mon field specify regular report instance moniker with the !DataArea!DataSources!<data source key>!DataSourceSlices!<slice key>!Pivot! postfix. This moniker should also be appended with one of the following values:

• TopHeader - to work with columns header.

• LeftHeader - to work with rows header.

The moniker can be obtained on executing the OpenPrxMeta operation.

In the tArg field set empty values or default values for the fields, which values should be obtained. The operation returns the obtained settings for data slice header.

Example

Below is the example for getting columns header settings of data slice. The request contains moniker for working with the header and the list of fields, which values should be obtained. The response contains the requested settings.

SOAP JSONC#

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

<GetPivotHeaderMetaData xmlns="http://www.fsight.ru/PP.SOM.Som">

  <mon xmlns="">S1!M!S!P1!DataArea!DataSources!1!DataSourceSlices!1!Pivot!TopHeader</mon>

<tArg xmlns="">

<headerSettings>

<filter>

  <enabled>false</enabled>

  <suppressEmptyCells>false</suppressEmptyCells>

  <suppressZeroCells>false</suppressZeroCells>

  <suppressNoNumericCells>false</suppressNoNumericCells>

  </filter>

  </headerSettings>

  <separated>-1</separated>

  </tArg>

  </GetPivotHeaderMetaData>

  </s:Body>

  </s:Envelope>

SOAP response:

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

<soapenv:Body>

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

<headerSettings xmlns="">

<filter>

  <enabled>1</enabled>

  <suppressEmptyCells>0</suppressEmptyCells>

  <suppressZeroCells>0</suppressZeroCells>

  <suppressNoNumericCells>0</suppressNoNumericCells>

  </filter>

  </headerSettings>

  <separated xmlns="">1</separated>

  </GetPivotHeaderMetaDataResult>

  </soapenv:Body>

  </soapenv:Envelope>

JSON request:

{
 "GetPivotHeaderMetaData" : 
  {
   "mon" : "S1!M!S!P1!DataArea!DataSources!1!DataSourceSlices!1!Pivot!TopHeader",
   "tArg" : 
    {
     "headerSettings" : 
      {
       "filter" : 
        {
         "enabled" : "false",
         "suppressEmptyCells" : "false",
         "suppressZeroCells" : "false",
         "suppressNoNumericCells" : "false"
        }
      },
     "separated" : "-1"
    }
  }
}

JSON response:

{
 "GetPivotHeaderMetaDataResult" : 
  {
   "headerSettings" : 
    {
     "filter" : 
      {
       "enabled" : "1",
       "suppressEmptyCells" : "0",
       "suppressZeroCells" : "0",
       "suppressNoNumericCells" : "0"
      }
    },
   "separated" : "1"
  }
}

This is placeholder text for your snippet. To add content to the body, replace this text.

 

For information about applying snippets to topics, press F1.

See also:

Working with Regular Reports