GetPivotFilterMetaData: Operation

The GetPivotFilterMetaData operation gets data filtering settings specified for data slice.

Comments

To execute the operation, in the mon field specify moniker of regular report moniker with the !DataArea!DataSources!<source key>!DataSourceSlices!slice key!Pivot!Filter postfix, and 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 data filtering settings. The request contains moniker for working with filtering settings and a list of the 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!Filter</mon>

<enabled>false</enabled>

<suppressEmptyCells>false</suppressEmptyCells>

<suppressZeroCells>false</suppressZeroCells>

<suppressNoNumericCells>false</suppressNoNumericCells>

<separateHeaders>false</separateHeaders>

</tArg>

</GetPivotFilterMetaData>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</GetPivotFilterMetaDataResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

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

JSON response:

{
 "GetPivotFilterMetaDataResult" : 
  {
   "enabled" : "1",
   "suppressEmptyCells" : "1",
   "suppressZeroCells" : "0",
   "suppressNoNumericCells" : "0",
   "separateHeaders" : "0"
  }
}

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

GetPivotFilterMetaData

Syntax