GetDataAreaSources

Syntax

DataAreaSources GetDataAreaSources(string mon, DataAreaSources tArg)

Parameters

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

tArg. Operation execution parameters.

Description

The GetDataAreaSources operation gets information about analytical area data sources.

Comments

To execute the operation, in the mon field specify regular report opened instance moniker with the !DataArea!DataSources postfix to work with data sources, and in the tArg field specify parameters for getting metadata.

The moniker can be obtained on executing the OpenPrxMeta operation.

To get information about all data sources, in the tArg.its field specify one collection element and set empty values or default values for the fields, which values should be obtained. Specify -1 as a key value.

To get information about a specific data source, specify its key in the tArg.its collection element.

The operation results in the requested information about data sources.

Example

Below is the example of getting information about data sources of regular report analytical data area. The request contains moniker for working with data sources and the list of fields, which values should be obtained. The response contains the requested information about data sources.

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">
<GetDataAreaSources xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!DataArea!DataSources</mon>
<tArg xmlns="">
<its>
<it>
  <k>-1</k>
  <id />
  <n />
<slices>
<its>
<it>
  <k>-1</k>
  <id />
  <n />
  <type>Pivot</type>
<pivotSlice>
<pivot>
<dims>
<its>
<it>
  <k>-1</k>
  <id />
  <n />
  <position>Unknown</position>
  </it>
  </its>
  </dims>
  </pivot>
  </pivotSlice>
  </it>
  </its>
  </slices>
  </it>
  </its>
  </tArg>
  </GetDataAreaSources>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDataAreaSourcesResult 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">
<its xmlns="">
<it>
  <k>1</k>
<slices>
<its>
<it>
  <k>1</k>
  <id>ITEM</id>
  <n>ITEM</n>
  <type>Pivot</type>
<pivotSlice>
<pivot>
<dims>
<its>
<it>
  <k>5858</k>
  <id>FACTS</id>
  <n>Facts</n>
  <position>Fixed</position>
  </it>
<it>
  <k>112</k>
  <id>CALENDAR</id>
  <n>Calendar</n>
  <position>Top</position>
  </it>
<it>
  <k>116</k>
  <id>DIM_1</id>
  <n>Dim_1</n>
  <position>Left</position>
  </it>
<it>
  <k>991</k>
  <id>DIM_2</id>
  <n>Dim_2</n>
  <position>Fixed</position>
  </it>
  </its>
  </dims>
  </pivot>
  </pivotSlice>
  </it>
  </its>
  </slices>
  </it>
<it>
  <k>2</k>
<slices>
<its>
<it>
  <k>2</k>
  <id>ITEM1</id>
  <n>ITEM1</n>
  <type>Pivot</type>
<pivotSlice>
<pivot>
<dims>
<its>
<it>
  <k>116</k>
  <id>DIM_1</id>
  <n>Dim_1</n>
  <position>Left</position>
  </it>
<it>
  <k>112</k>
  <id>CALENDAR</id>
  <n>Calendar</n>
  <position>Top</position>
  </it>
  </its>
  </dims>
  </pivot>
  </pivotSlice>
  </it>
  </its>
  </slices>
  </it>
  </its>
  </GetDataAreaSourcesResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetDataAreaSources" :
{
"mon" : "S1!M!S!P1!DataArea!DataSources",
"tArg" :
{
"its" :
{
"it" :
[
{
"k" : "-1",
"id" : "",
"n" : "",
"slices" :
{
"its" :
{
"it" :
[
{
"k" : "-1",
"id" : "",
"n" : "",
"type" : "Pivot",
"pivotSlice" :
{
"pivot" :
{
"dims" :
{
"its" :
{
"it" :
[
{
"k" : "-1",
"id" : "",
"n" : "",
"position" : "Unknown"
}
]
}
}
}
}
}
]
}
}
}
]
}
}
}
}

JSON response:

{
"GetDataAreaSourcesResult" :
{
"its" :
{
"it" :
[
{
"k" : "1",
"slices" :
{
"its" :
{
"it" :
[
{
"k" : "1",
"id" : "ITEM",
"n" : "ITEM",
"type" : "Pivot",
"pivotSlice" :
{
"pivot" :
{
"dims" :
{
"its" :
{
"it" :
[
{
"k" : "5858",
"id" : "FACTS",
"n" : "Facts",
"position" : "Fixed"
},
{
"k" : "112",
"id" : "CALENDAR",
"n" : "Calendar",
"position" : "Top"
},
{
"k" : "116",
"id" : "DIM_1",
"n" : "Dim_1",
"position" : "Left"
},
{
"k" : "991",
"id" : "DIM_2",
"n" : "Dim_2",
"position" : "Fixed"
}
]
}
}
}
}
}
]
}
}
},
{
"k" : "2",
"slices" :
{
"its" :
{
"it" :
[
{
"k" : "2",
"id" : "ITEM1",
"n" : "ITEM1",
"type" : "Pivot",
"pivotSlice" :
{
"pivot" :
{
"dims" :
{
"its" :
{
"it" :
[
{
"k" : "116",
"id" : "DIM_1",
"n" : "Dim_1",
"position" : "Left"
},
{
"k" : "112",
"id" : "CALENDAR",
"n" : "Calendar",
"position" : "Top"
}
]
}
}
}
}
}
]
}
}
}
]
}
}
}
public static DataAreaSources GetPrxDataSources(string moniker)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tGet = new GetDataAreaSources()
{
tArg = new DataAreaSources()
{
its = new DataAreaSource[1]
{
new DataAreaSource()
{
k = uint.MaxValue,
n = "",
id = "",
slices = new DataAreaSlices()
{
its = new DataAreaSlice[1]
{
new DataAreaSlice()
{
k = uint.MaxValue,
n = "",
id = "",
type = EaxDataAreaSliceType.Pivot,
pivotSlice = new DataAreaPivotSlice()
{
pivot = new PivotMetaData()
{
dims = new PivotDimensions()
{
its = new PivotDimension[1]
{
new PivotDimension(){ k = uint.MaxValue, n = "", id = "", position = PvtDimPos.Unknown }
}
}
}
}
}
}
}
}
}
},
mon = moniker + "!DataArea!DataSources"
};
//Get information about data sources
var result = somClient.GetDataAreaSources(tGet);
return result;
}

See also:

Working With Regular Reports