GetPivotDimElementTotal: Operation

PivotDimElementTotal GetPivotDimElementTotal(string mon, PivotDimElementTotal tArg)

Parameters

Description

The GetPivotDimElementTotal operation gets settings of own total type calculation for a dimension element.

Comments

To execute the operation, in the mon field specify moniker of regular report instance with the !DataArea!DataSources!source key!DataSourceSlices!slice key!Pivot!Totals postfix to work with totals, and in the tArg field specify dimension key and element key, for which settings will be obtained. The moniker can be obtained on executing the OpenPrxMeta operation.

The operation results in the obtained own total type calculation settings for a dimension element.

Example

Below is the example of getting own total type calculation settings for a dimension element. The request contains moniker for working with totals, dimension key, and element key. The response contains the obtained total calculation 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="">IGKCBLACHJHFGOAECPFHIBAHKDNEEELENJKICJHOLDFGIJAG!M!S!PPMAJAPACHJHFGOAEPIAFFPEFHCEHPGKELLHHEFOLEHCDAEHK!DataArea!DataSources!1!DataSourceSlices!1!Pivot!Totals</mon>

</elementKey>

</tArg>

</GetPivotDimElementTotal>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</elementKey>

</GetPivotDimElementTotalResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetPivotDimElementTotal" : 
  {
   "mon" : "IGKCBLACHJHFGOAECPFHIBAHKDNEEELENJKICJHOLDFGIJAG!M!S!PPMAJAPACHJHFGOAEPIAFFPEFHCEHPGKELLHHEFOLEHCDAEHK!DataArea!DataSources!1!DataSourceSlices!1!Pivot!Totals",
   "tArg" : 
    {
     "elementKey" : 
      {
       "key" : "1"
      },
     "dimKey" : "116"
    }
  }
}

JSON response:

{
 "GetPivotDimElementTotalResult" : 
  {
   "elementKey" : 
    {
     "key" : "1"
    },
   "dimKey" : "116",
   "type" : "Avg",
   "enabled" : "1"
  }
}

public static PivotDimElementTotal GetPivotDimElementTotal(string moniker, uint dataSourceKey, uint sliceKey, uint dimKey, string elKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetPivotDimElementTotal()
    {
        tArg = new PivotDimElementTotal()
        {
            dimKey = dimKey,
            elementKey = new ElKey(){ key = elKey }
        },
        mon = moniker + "!DataArea!DataSources!" + dataSourceKey + "!DataSourceSlices!" + sliceKey + "!Pivot!Totals"
    };
    // Get own total type calculation settings for a dimension element
    var result = somClient.GetPivotDimElementTotal(tGet);
    return result;
}

GetPivotDimElementTotal

Syntax