Show contents 

Web Service > Web Service Operations > Working with Regular Reports > ClearDataAreaHierarchy

ClearDataAreaHierarchy

Syntax

bool ClearDataAreaHierarchy(string mon)

Parameters

mon. Moniker for working with regular report analytical data area.

tArg. Operation execution parameters.

Description

The ClearDataAreaHierarchy operation resets the custom hierarchy that was set up for the analytical data area slice dimension.

Comments

To execute the operation, in the mon field specify regular report instance moniker with the !DataArea postfix to work with analytical data area, and in the tArg field specify the slice and the dimension, for which the custom hierarchy should be reset. The moniker can be obtained on executing the OpenPrxMeta operation.

The operation results in the logical true if the custom hierarchy is reset successfully.

Example

Below is the example of resetting custom hierarchy for a slice dimension. The request contains moniker for working with analytical data area, key of the slice and the dimension, for which custom hierarchy should be reset. The response contains whether the custom hierarchy was reset successfully.

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">
<ClearDataAreaHierarchy xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">CKBLCOMLGNPDGOAEOLMBENEEMJJPNLBEEJELMKJMFJMDPPKA!M!S!PJFDFHPMLGNPDGOAEIIKFLFJDIJHOCIHEOIELENPBPJCMFKEE!DataArea</mon>
<tArg xmlns="">
  <sliceKey>1</sliceKey>
  <dimKey>116</dimKey>
  </tArg>
  </ClearDataAreaHierarchy>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <ClearDataAreaHierarchyResult 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">1</ClearDataAreaHierarchyResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "ClearDataAreaHierarchy" : 
  {
   "mon" : "CKBLCOMLGNPDGOAEOLMBENEEMJJPNLBEEJELMKJMFJMDPPKA!M!S!PJFDFHPMLGNPDGOAEIIKFLFJDIJHOCIHEOIELENPBPJCMFKEE!DataArea",
   "tArg" : 
    {
     "sliceKey" : "1",
     "dimKey" : "116"
    }
  }
}

JSON response:

{
 "ClearDataAreaHierarchyResult" : "1"
}
public static bool ClearDataAreaHierarchy(string moniker, uint sliceKey, uint dimKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new ClearDataAreaHierarchy()
    {
        tArg = new ClearDataAreaSliceHierarchy()
        {
            sliceKey = sliceKey,
            dimKey = dimKey
        },
        mon = moniker + "!DataArea"
    };
    // Reset custom hierarchy
    var result = somClient.ClearDataAreaHierarchy(tSet);
    return result;
}

See also:

Working with Regular Reports