Show contents 

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

GetDataAreaSlice

Syntax

DataAreaSlice GetDataAreaSlice(string mon, DataAreaSlice tArg)

Parameters

mon. Moniker for working with analytical data area slice.

tArg. Slice settings that should be obtained.

Description

The GetDataAreaSlice operation gets information about analytical area data slice.

Comments

To execute the operation, in the mon field specify regular report instance moniker with the DataArea!DataSources!source key!DataSourceSlices!slice key postfix to work with dimension settings, and in the tArg field specify empty values or default values for the fields, which values should be obtained. The moniker can be obtained on executing the OpenPrxMeta operation.

The operation results in the obtained analytical data area slice settings.

Example

Below is the example of getting information about data slice dimensions. The request contains analytical data area moniker and the list of obtained fields. The response contains the obtained information about dimensions.

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">
<GetDataAreaSlice xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">MFMABINKFPPDGOAEOBOOGFNHBKBGDINECKCPBCDFBECFODJM!M!S!PJGOCAMNKFPPDGOAEBKLCKKHMBCAFDKDEMLAJMEJFLDNGLJMJ!DataArea!DataSources!1!DataSourceSlices!1</mon>
<tArg xmlns="">
  <k>1</k>
<pivotSlice>
<pivot>
<dims>
<its>
<it>
  <k>-1</k>
  <id />
  <n />
<dimMetadata>
<id>
  <id />
  </id>
<data>
<selection>
  <selectedCount>-1</selectedCount>
  </selection>
  </data>
<els>
<id>
  <id />
  </id>
  </els>
  </dimMetadata>
  </it>
  </its>
  </dims>
  </pivot>
  </pivotSlice>
  </tArg>
  </GetDataAreaSlice>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDataAreaSliceResult 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="">1</k>
<pivotSlice xmlns="">
<pivot>
<dims>
<its>
<it>
  <k>339501</k>
  <id>FACTS</id>
  <n>Facts</n>
<dimMetadata>
<id>
  <id />
  </id>
<data>
<obInst>
<obDesc ds="" isShortcut="0" isLink="0" ver="2" hf="0">
  <i>FACTS</i>
  <n>Facts</n>
  <k>339501</k>
  <c>1028</c>
  <p>339499</p>
  <h>0</h>
  <hasPrv>0</hasPrv>
  <ic>0</ic>
  <trackElementDependents>0</trackElementDependents>
  <isPermanent>1</isPermanent>
  <isTemp>0</isTemp>
  </obDesc>
  <openArgs />
  </obInst>
<selection>
  <selectedCount>1</selectedCount>
<schema>
  <k>-1</k>
  <vis>1</vis>
  <applyOnlyOnce>0</applyOnlyOnce>
  <onceApplied>1</onceApplied>
  <applyOnRebuild>0</applyOnRebuild>
  </schema>
  <allowToChangeElementGroup>1</allowToChangeElementGroup>
  </selection>
  <isAbacSecured>0</isAbacSecured>
  </data>
<els>
  <els />
  <totalCount>1</totalCount>
<id>
  <id />
  </id>
<selectionInfo>
<firstSelected>
  <n>Value</n>
  <k>1</k>
  <h>0</h>
  <o>0</o>
  </firstSelected>
<lastSelected>
  <n>Value</n>
  <k>1</k>
  <h>0</h>
  <o>0</o>
  </lastSelected>
  <selectedCount>1</selectedCount>
<schema>
  <k>-1</k>
  <vis>1</vis>
  <applyOnlyOnce>0</applyOnlyOnce>
  <onceApplied>1</onceApplied>
  <applyOnRebuild>0</applyOnRebuild>
  </schema>
  </selectionInfo>
  </els>
  </dimMetadata>
  </it>
<it>
  <k>339497</k>
  <id>OBJ339497</id>
  <n>Calendar</n>
<dimMetadata>
<id>
  <id />
  </id>
<data>
<obInst>
<obDesc ds="" isShortcut="0" isLink="0" ver="1" hf="0">
  <i>OBJ339497</i>
  <n>Calendar</n>
  <k>339497</k>
  <c>1026</c>
  <p>339494</p>
  <h>0</h>
  <hasPrv>0</hasPrv>
  <ic>0</ic>
  <trackElementDependents>0</trackElementDependents>
  <isPermanent>1</isPermanent>
  <isTemp>0</isTemp>
  </obDesc>
  <openArgs />
  </obInst>
<selection>
  <selectedCount>11</selectedCount>
<schema>
  <k>-1</k>
  <vis>1</vis>
  <applyOnlyOnce>0</applyOnlyOnce>
  <onceApplied>1</onceApplied>
  <applyOnRebuild>0</applyOnRebuild>
  </schema>
  <allowToChangeElementGroup>1</allowToChangeElementGroup>
  </selection>
  <isAbacSecured>0</isAbacSecured>
  </data>
<els>
  <els />
  <totalCount>11</totalCount>
<id>
  <id />
  </id>
<selectionInfo>
<firstSelected>
  <n>2010</n>
  <k>YEARS:2010</k>
  <h>0</h>
  <o>0</o>
  </firstSelected>
<lastSelected>
  <n>2020</n>
  <k>YEARS:2020</k>
  <h>0</h>
  <o>0</o>
  </lastSelected>
  <selectedCount>11</selectedCount>
<calendarPeriod>
  <active>0</active>
  <start>2010-01-01</start>
  <end>2020-12-31</end>
<levels>
  <it>Year</it>
  </levels>
  </calendarPeriod>
<schema>
  <k>-1</k>
  <vis>1</vis>
  <applyOnlyOnce>0</applyOnlyOnce>
  <onceApplied>1</onceApplied>
  <applyOnRebuild>0</applyOnRebuild>
  </schema>
  </selectionInfo>
  </els>
  </dimMetadata>
  </it>
<it>
  <k>339495</k>
  <id>OBJ339495</id>
  <n>Dictionary</n>
<dimMetadata>
<id>
  <id />
  </id>
<data>
<obInst>
<obDesc ds="" isShortcut="0" isLink="0" ver="3" hf="0">
  <i>OBJ339495</i>
  <n>Dictionary</n>
  <k>339495</k>
  <c>3076</c>
  <p>339494</p>
  <h>0</h>
  <hasPrv>0</hasPrv>
  <ic>0</ic>
  <trackElementDependents>0</trackElementDependents>
  <isPermanent>1</isPermanent>
  <isTemp>0</isTemp>
  </obDesc>
  <openArgs />
  </obInst>
<selection>
  <selectedCount>3</selectedCount>
<schema>
  <k>-1</k>
  <vis>1</vis>
  <applyOnlyOnce>0</applyOnlyOnce>
  <onceApplied>1</onceApplied>
  <applyOnRebuild>0</applyOnRebuild>
  </schema>
  <allowToChangeElementGroup>1</allowToChangeElementGroup>
  </selection>
  <isAbacSecured>0</isAbacSecured>
  </data>
<els>
  <els />
  <totalCount>3</totalCount>
<id>
  <id />
  </id>
<selectionInfo>
<firstSelected>
  <n>Debit</n>
  <k>1</k>
  <h>0</h>
  <o>0</o>
  </firstSelected>
<lastSelected>
  <n>Balance</n>
  <k>3</k>
  <h>0</h>
  <o>0</o>
  </lastSelected>
  <selectedCount>3</selectedCount>
<schema>
  <k>-1</k>
  <vis>1</vis>
  <applyOnlyOnce>0</applyOnlyOnce>
  <onceApplied>1</onceApplied>
  <applyOnRebuild>0</applyOnRebuild>
  </schema>
  </selectionInfo>
  </els>
  </dimMetadata>
  </it>
  </its>
  </dims>
  <drillThrough>0</drillThrough>
  </pivot>
  </pivotSlice>
  </GetDataAreaSliceResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetDataAreaSlice" : 
  {
   "mon" : "MFMABINKFPPDGOAEOBOOGFNHBKBGDINECKCPBCDFBECFODJM!M!S!PJGOCAMNKFPPDGOAEBKLCKKHMBCAFDKDEMLAJMEJFLDNGLJMJ!DataArea!DataSources!1!DataSourceSlices!1",
   "tArg" : 
    {
     "k" : "1",
     "pivotSlice" : 
      {
       "pivot" : 
        {
         "dims" : 
          {
           "its" : 
            {
             "it" : 
              [
                {
                 "k" : "-1",
                 "id" : "",
                 "n" : "",
                 "dimMetadata" : 
                  {
                   "id" : 
                    {
                     "id" : ""
                    },
                   "data" : 
                    {
                     "selection" : 
                      {
                       "selectedCount" : "-1"
                      }
                    },
                   "els" : 
                    {
                     "id" : 
                      {
                       "id" : ""
                      }
                    }
                  }
                }
              ]
            }
          }
        }
      }
    }
  }
}

JSON response:

{
 "GetDataAreaSliceResult" : 
  {
   "k" : "1",
   "pivotSlice" : 
    {
     "pivot" : 
      {
       "dims" : 
        {
         "its" : 
          {
           "it" : 
            [
              {
               "k" : "339501",
               "id" : "FACTS",
               "n" : "Facts",
               "dimMetadata" : 
                {
                 "id" : 
                  {
                   "id" : ""
                  },
                 "data" : 
                  {
                   "obInst" : 
                    {
                     "obDesc" : 
                      {
                       "@ds" : "",
                       "@isShortcut" : "0",
                       "@isLink" : "0",
                       "@ver" : "2",
                       "@hf" : "0",
                       "i" : "FACTS",
                       "n" : "Facts",
                       "k" : "339501",
                       "c" : "1028",
                       "p" : "339499",
                       "h" : "0",
                       "hasPrv" : "0",
                       "ic" : "0",
                       "trackElementDependents" : "0",
                       "isPermanent" : "1",
                       "isTemp" : "0"
                      },
                     "openArgs" : ""
                    },
                   "selection" : 
                    {
                     "selectedCount" : "1",
                     "schema" : 
                      {
                       "k" : "4294967295",
                       "vis" : "1",
                       "applyOnlyOnce" : "0",
                       "onceApplied" : "1",
                       "applyOnRebuild" : "0"
                      },
                     "allowToChangeElementGroup" : "1"
                    },
                   "isAbacSecured" : "0"
                  },
                 "els" : 
                  {
                   "els" : "",
                   "totalCount" : "1",
                   "id" : 
                    {
                     "id" : ""
                    },
                   "selectionInfo" : 
                    {
                     "firstSelected" : 
                      {
                       "n" : "Value",
                       "k" : "1",
                       "h" : "0",
                       "o" : "0"
                      },
                     "lastSelected" : 
                      {
                       "n" : "Value",
                       "k" : "1",
                       "h" : "0",
                       "o" : "0"
                      },
                     "selectedCount" : "1",
                     "schema" : 
                      {
                       "k" : "4294967295",
                       "vis" : "1",
                       "applyOnlyOnce" : "0",
                       "onceApplied" : "1",
                       "applyOnRebuild" : "0"
                      }
                    }
                  }
                }
              },
              {
               "k" : "339497",
               "id" : "OBJ339497",
               "n" : "Calendar",
               "dimMetadata" : 
                {
                 "id" : 
                  {
                   "id" : ""
                  },
                 "data" : 
                  {
                   "obInst" : 
                    {
                     "obDesc" : 
                      {
                       "@ds" : "",
                       "@isShortcut" : "0",
                       "@isLink" : "0",
                       "@ver" : "1",
                       "@hf" : "0",
                       "i" : "OBJ339497",
                       "n" : "Calendar",
                       "k" : "339497",
                       "c" : "1026",
                       "p" : "339494",
                       "h" : "0",
                       "hasPrv" : "0",
                       "ic" : "0",
                       "trackElementDependents" : "0",
                       "isPermanent" : "1",
                       "isTemp" : "0"
                      },
                     "openArgs" : ""
                    },
                   "selection" : 
                    {
                     "selectedCount" : "11",
                     "schema" : 
                      {
                       "k" : "4294967295",
                       "vis" : "1",
                       "applyOnlyOnce" : "0",
                       "onceApplied" : "1",
                       "applyOnRebuild" : "0"
                      },
                     "allowToChangeElementGroup" : "1"
                    },
                   "isAbacSecured" : "0"
                  },
                 "els" : 
                  {
                   "els" : "",
                   "totalCount" : "11",
                   "id" : 
                    {
                     "id" : ""
                    },
                   "selectionInfo" : 
                    {
                     "firstSelected" : 
                      {
                       "n" : "2010",
                       "k" : "YEARS:2010",
                       "h" : "0",
                       "o" : "0"
                      },
                     "lastSelected" : 
                      {
                       "n" : "2020",
                       "k" : "YEARS:2020",
                       "h" : "0",
                       "o" : "0"
                      },
                     "selectedCount" : "11",
                     "calendarPeriod" : 
                      {
                       "active" : "0",
                       "start" : "2010-01-01",
                       "end" : "2020-12-31",
                       "levels" : 
                        {
                         "it" : "Year"
                        }
                      },
                     "schema" : 
                      {
                       "k" : "4294967295",
                       "vis" : "1",
                       "applyOnlyOnce" : "0",
                       "onceApplied" : "1",
                       "applyOnRebuild" : "0"
                      }
                    }
                  }
                }
              },
              {
               "k" : "339495",
               "id" : "OBJ339495",
               "n" : "Dictionary",
               "dimMetadata" : 
                {
                 "id" : 
                  {
                   "id" : ""
                  },
                 "data" : 
                  {
                   "obInst" : 
                    {
                     "obDesc" : 
                      {
                       "@ds" : "",
                       "@isShortcut" : "0",
                       "@isLink" : "0",
                       "@ver" : "3",
                       "@hf" : "0",
                       "i" : "OBJ339495",
                       "n" : "Dictionary",
                       "k" : "339495",
                       "c" : "3076",
                       "p" : "339494",
                       "h" : "0",
                       "hasPrv" : "0",
                       "ic" : "0",
                       "trackElementDependents" : "0",
                       "isPermanent" : "1",
                       "isTemp" : "0"
                      },
                     "openArgs" : ""
                    },
                   "selection" : 
                    {
                     "selectedCount" : "3",
                     "schema" : 
                      {
                       "k" : "4294967295",
                       "vis" : "1",
                       "applyOnlyOnce" : "0",
                       "onceApplied" : "1",
                       "applyOnRebuild" : "0"
                      },
                     "allowToChangeElementGroup" : "1"
                    },
                   "isAbacSecured" : "0"
                  },
                 "els" : 
                  {
                   "els" : "",
                   "totalCount" : "3",
                   "id" : 
                    {
                     "id" : ""
                    },
                   "selectionInfo" : 
                    {
                     "firstSelected" : 
                      {
                       "n" : "Debit",
                       "k" : "1",
                       "h" : "0",
                       "o" : "0"
                      },
                     "lastSelected" : 
                      {
                       "n" : "Balance",
                       "k" : "3",
                       "h" : "0",
                       "o" : "0"
                      },
                     "selectedCount" : "3",
                     "schema" : 
                      {
                       "k" : "4294967295",
                       "vis" : "1",
                       "applyOnlyOnce" : "0",
                       "onceApplied" : "1",
                       "applyOnRebuild" : "0"
                      }
                    }
                  }
                }
              }
            ]
          }
        },
       "drillThrough" : "0"
      }
    }
  }
}
public static DataAreaSlice GetDataAreaSlice(string moniker, uint sourceKey, uint sliceKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new GetDataAreaSlice()
    {
        tArg = new DataAreaSlice()
        {
            k = sliceKey,
            pivotSlice = new DataAreaPivotSlice()
            {
                pivot = new PivotMetaData()
                {
                    dims = new PivotDimensions()
                    {
                        its = new PivotDimension[]
                        {
                            new PivotDimension()
                            {
                                id = string.Empty,
                                n = string.Empty,
                                k = uint.MaxValue,
                                dimMetadata = new GetDimMetadataResult()
                                {
                                    data = new DmMetadata()
                                    {
                                        selection = new DmSelectionMeta()
                                        {
                                            selectedCount = -1
                                        }
                                    },
                                    els = new GetDimElementsResult()
                                    {
                                        id = new DmId() { id = string.Empty }
                                    },
                                    id = new DmId(){ id = string.Empty }
                                }
                            }
                        }
                    }
                }
            }
        },
        mon = moniker + "!DataArea!DataSources!" + sourceKey + "!DataSourceSlices!" + sliceKey
    };
    // Get analytical data area slice settings
    var result = somClient.GetDataAreaSlice(tSet);
    return result;
}

See also:

Working with Regular Reports