Selecting Elements by Their Keys: the GetDimElements Operation

Below is the example of using the GetDimElements operation to select elements by their keys. The key is the value of the Identifier attribute for an element. The request contains moniker of opened dictionary instance and the collection of element keys. 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>

<keys>

<it>

</it>

<it>

</it>

<it>

</it>

</keys>

<includeParents>false</includeParents>

<includeParentsWithSiblings>false</includeParentsWithSiblings>

</filter>

</pattern>

</tArg>

</GetDimElements>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

<e>

<n>First element</n>

<a>

<it>First element</it>

</a>

<ea>

</ea>

</e>

<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" : 
      {
       "keys" : 
        {
         "it" : 
          [

            {
             "key" : "1"
            },
            {
             "key" : "2"
            },
            {
             "key" : "3"
            }
          ]

        },
       "includeParents" : "false",
       "includeParentsWithSiblings" : "false"
      },
     "pattern" : 
      {
       "attributes" : "ID;NAME"
      }
    }
  }
}

JSON response:

{
"GetDimElementsResult" : 
{
"els" : 
{
"e" : 
[
{
"n" : "Item 1",
"a" : 
{
"it" :

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

"@v" : "1"
},
{
"@v" : "Item 1"
}
]
},
"k" : "1",
"h" : "0",
"o" : "0"

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

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

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

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

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

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

    public static GetDimElementsResult GetElementsByKeys(DmId moniker, ElKey[] elKeys)
    {
        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()
                {
                    keys = elKeys
                }
            },
            tDim = moniker
        };
        //Get information on dictionary elements
        var result = somClient.GetDimElements(tElements);
        return result;
    }