Selecting Elements Corresponding to Group of Elements: the GetDimElements Operation

Below is the example of using the GetDimElements operation to select elements using a group of dictionary elements. The request contains moniker of opened dictionary instance and the element group identifier. Identifiers and names will be loaded for selected elements.

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">

</tDim>

<includeParents>false</includeParents>

<includeParentsWithSiblings>false</includeParentsWithSiblings>

<group>

<id>GROUP1</id>

</group>

</filter>

</pattern>

</tArg>

</GetDimElements>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

<e>

<n>Second element</n>

<a>

<it>Second element</it>

</a>

<ea>

</ea>

</e>

<e>

<n>Third element</n>

<a>

<it>Third element</it>

</a>

<ea>

</ea>

</e>

</els>

</id>

</GetDimElementsResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetDimElements" : 
  {
   "tDim" : 
    {

     "id" : "S1!M!S!S1"
    },
   "tArg" : 
    {
     "filter" : 
      {
       "includeParents" : "false",
       "includeParentsWithSiblings" : "false",
       "group" : 
        {

         "k" : "18446744073709551615",
         "id" : "GROUP1"
        }
      },
     "pattern" : 
      {
       "attributes" : "ID;NAME"
      }
    }
  }
}

JSON response:

{
 "GetDimElementsResult" : 
  {
   "els" : 
    {
     "e" :

[
{
"n" : "Item 2",
"a" : 
{
"it" : 
[
"2",
"Item 2"
]

},
"ea" : 
{
"it" : 
[
{
"@v" : "2"
},
{
"@v" : "Item 2"

}
]
},
"k" : "2",
"h" : "0",
"o" : "0"
},
{
"n" : "Item 3",
"a" :

{
"it" : 
[
"3",
"Item 3"
]
},
"ea" : 
{
"it" :

[
{
"@v" : "3"
},
{
"@v" : "Item 3"
}
]
},
"k" : "3",

         "h" : "0",
         "o" : "1"
        }
      ]
    },
   "id" : 
    {
     "id" : "S1!M!S!S1"
    }
  }
}

    public static GetDimElementsResult GetGroupElements(DmId moniker, string groupId)
    {
        var somClient = new SomPortTypeClient(); //Proxy object for operation execution
        //Operation execution parameters
        var tElements = new GetDimElements()
        {
            tArg = new GetDimElementsArg()
            {
                pattern = new ElsPattern()
                {
                    attributes = "ID;NAME"
                },
                //Element filtering parameters
                filter = new ElsFilter()
                {
                    group = new ItKey() { id = groupId, k = ulong.MaxValue }
                }
            },
            tDim = moniker
        };
        //Get information on dictionary elements
        var result = somClient.GetDimElements(tElements);
        return result;
    }