GetPivotHeaderFilterMetaData: Operation

PivotHeaderFilter GetPivotHeaderFilterMetaData(string mon, PivotHeaderFilter tArg)

Parameters

Description

The GetPivotHeaderFilterMetaData operation gets filtering settings for data slice header.

Comments

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:

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

Example

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

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="">S1!M!S!P1!DataArea!DataSources!1!DataSourceSlices!1!Pivot!TopHeader!HeaderSettings!Filter</mon>

<enabled>false</enabled>

<suppressEmptyCells>false</suppressEmptyCells>

<suppressZeroCells>false</suppressZeroCells>

<suppressNoNumericCells>false</suppressNoNumericCells>

</tArg>

</GetPivotHeaderFilterMetaData>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</GetPivotHeaderFilterMetaDataResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetPivotHeaderFilterMetaData" : 
  {
   "mon" : "S1!M!S!P1!DataArea!DataSources!1!DataSourceSlices!1!Pivot!TopHeader!HeaderSettings!Filter",
   "tArg" : 
    {
     "enabled" : "false",
     "suppressEmptyCells" : "false",
     "suppressZeroCells" : "false",
     "suppressNoNumericCells" : "false"
    }
  }
}

JSON response:

{
 "GetPivotHeaderFilterMetaDataResult" : 
  {
   "enabled" : "1",
   "suppressEmptyCells" : "1",
   "suppressZeroCells" : "0",
   "suppressNoNumericCells" : "0"
  }
}

public static PivotHeaderFilter GetPivotHeaderFilter(string moniker, uint dataSourceKey, uint sliceKey)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tGet = new GetPivotHeaderFilterMetaData()
    {
        tArg = new PivotHeaderFilter()
        {
            enabled = new bool(),
            suppressEmptyCells = new bool(),
            suppressNoNumericCells = new bool(),
            suppressZeroCells = new bool()
        },
        mon = moniker + "!DataArea!DataSources!" + dataSourceKey.ToString() + "!DataSourceSlices!" + sliceKey.ToString() + "!Pivot!TopHeader!HeaderSettings!Filter"
    };
    //Get information about header filter
    var result = somClient.GetPivotHeaderFilterMetaData(tGet);
    return result;
}

GetPivotHeaderFilterMetaData

Syntax