GetPivotDimensionMetaData

Syntax

PivotDimension GetPivotDimensionMetaData(string mon, PivotDimension tArg)

Parameters

mon. Moniker for working with data slice dimension.

tArg. Dimension parameters that should be obtained.

Description

The GetPivotDimensionMetaData operation gets information about data slice dimension.

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!PivotDims!<dimension key> postfix to work with the dimension, and in the tArg field specify empty values or default values for the parameters, which values should be obtained.

The moniker can be obtained on executing the OpenPrxMeta operation.

The operation returns obtained dimension parameters.

Example

Below is the example of getting information about data slice dimension. The request contains moniker for working with dimension and a list of the fields, which values should be obtained. The response contains the obtained information.

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">
<GetPivotDimensionMetaData xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!DataArea!DataSources!1!DataSourceSlices!1!Pivot!PivotDims!116</mon>
<tArg xmlns="">
  <k>0</k>
  <id />
  <n />
  <position>Unknown</position>
  <index>0</index>
  <separated>0</separated>
  </tArg>
  </GetPivotDimensionMetaData>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetPivotDimensionMetaDataResult 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">
  <k xmlns="">116</k>
  <id xmlns="">DIM_1</id>
  <n xmlns="">Dim_1</n>
  <position xmlns="">Left</position>
  <index xmlns="">1</index>
  <separated xmlns="">1</separated>
  </GetPivotDimensionMetaDataResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetPivotDimensionMetaData" :
{
"mon" : "S1!M!S!P1!DataArea!DataSources!1!DataSourceSlices!1!Pivot!PivotDims!116",
"tArg" :
{
"k" : "0",
"id" : "",
"n" : "",
"position" : "Unknown",
"index" : "0",
"separated" : "0"
}
}
}

JSON response:

{
"GetPivotDimensionMetaDataResult" :
{
"k" : "116",
"id" : "DIM_1",
"n" : "Dim_1",
"position" : "Left",
"index" : "1",
"separated" : "1"
}
}
public static PivotDimension GetPivotDimMetadata(string moniker, uint dataSourceKey, uint sliceKey, uint dimKey)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tGet = new GetPivotDimensionMetaData()
{
tArg = new PivotDimension()
{
id = "",
n = "",
index = new long(),
position = new PvtDimPos(),
separated = new int()
},
mon = moniker + "!DataArea!DataSources!" + dataSourceKey.ToString() + "!DataSourceSlices!" + sliceKey.ToString() + "!Pivot!PivotDims!" + dimKey.ToString()
};
//Get information about dimension
var result = somClient.GetPivotDimensionMetaData(tGet);
return result;
}

See also:

Working With Regular Reports