GetRds

Syntax

GetRdsResult GetRds(RdsId tRds, GetRds tGet)

Parameters

tRds. MDM dictionary instance moniker.

tGet. Parameters of metadata getting.

Description

The GetRds operation gets MDM dictionary metadata.

Comments

This operation enables the user to get the following information about MDM dictionary structure:

To execute the operation, in the tRds parameter specify the dictionary instance moniker, and in the tArg parameter specify the parameters, according to which the information is obtained. The moniker can be obtained on executing the OpenRds operation. In the tArg.pattern field specify the pattern for getting information about dictionary structure. The operation results in the requested data.

Example

Below is the example of getting MDM dictionary metadata. The request contains moniker of opened dictionary instance and the pattern that determines whether it is necessary to get all dictionary metadata. 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">
<GetRds xmlns="http://www.fsight.ru/PP.SOM.Som">
<tRds xmlns="">
  <id>S1!M!S!N2</id>
  </tRds>
<tArg xmlns="">
<pattern>
  <obInst>true</obInst>
  <all>true</all>
  </pattern>
  </tArg>
  </GetRds>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetRdsResult 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">
<id xmlns="">
  <id>S1!M!S!N2</id>
  </id>
<meta xmlns="">
<obInst>
<obDesc ds="" isShortcut="0" isLink="0" ver="4" hf="0">
  <i>FACT_ELEMENTS</i>
  <n>Dictionary with indicators</n>
  <k>219797</k>
  <c>3076</c>
  <p>5611</p>
  <h>0</h>
  <hasPrv>0</hasPrv>
  <ic>0</ic>
  <trackElementDependents>0</trackElementDependents>
  <isPermanent>1</isPermanent>
  <isTemp>0</isTemp>
  </obDesc>
  </obInst>
  <dirty>0</dirty>
<attrs>
<its>
<it>
  <k>1</k>
  <id>KEY</id>
  <n>Key</n>
  <vis>0</vis>
  <predefined>Key</predefined>
  <dt>2</dt>
  <kind>Predefined</kind>
  <nullable>0</nullable>
  <hasMultipleValues>0</hasMultipleValues>
  <readAccess />
  <writeAccess />
  <timeDependent>0</timeDependent>
  <tag />
  <visibleForEdit>0</visibleForEdit>
  <isTranslation>0</isTranslation>
  <dataDomain>0</dataDomain>
  <defExpr />
  <isObjectLinked>0</isObjectLinked>
  <hasHierarchy>0</hasHierarchy>
  </it>
<it>
  <k>2</k>
  <id>NAME</id>
  <n>Name</n>
  <vis>1</vis>
  <predefined>Name</predefined>
  <dt>1</dt>
  <kind>Predefined</kind>
  <nullable>0</nullable>
  <hasMultipleValues>0</hasMultipleValues>
  <readAccess />
  <writeAccess />
  <timeDependent>0</timeDependent>
  <tag />
  <visibleForEdit>1</visibleForEdit>
  <isTranslation>0</isTranslation>
  <dataDomain>0</dataDomain>
  <defExpr />
  <isObjectLinked>0</isObjectLinked>
  <hasHierarchy>0</hasHierarchy>
  </it>
<it>
  <k>3</k>
  <id>PARENT_KEY</id>
  <n>Owner</n>
  <vis>0</vis>
  <predefined>ParentKey</predefined>
  <dt>2</dt>
  <kind>Predefined</kind>
  <nullable>1</nullable>
  <hasMultipleValues>0</hasMultipleValues>
  <readAccess />
  <writeAccess />
  <timeDependent>0</timeDependent>
  <tag />
  <visibleForEdit>0</visibleForEdit>
  <isTranslation>0</isTranslation>
  <dataDomain>0</dataDomain>
  <defExpr />
  <isObjectLinked>0</isObjectLinked>
  <hasHierarchy>0</hasHierarchy>
  </it>
<it>
  <k>4</k>
  <id>ORD</id>
  <n>Order</n>
  <vis>0</vis>
  <predefined>Order</predefined>
  <dt>2</dt>
  <kind>Predefined</kind>
  <nullable>0</nullable>
  <hasMultipleValues>0</hasMultipleValues>
  <readAccess />
  <writeAccess />
  <timeDependent>0</timeDependent>
  <tag />
  <visibleForEdit>0</visibleForEdit>
  <isTranslation>0</isTranslation>
  <dataDomain>0</dataDomain>
  <defExpr />
  <isObjectLinked>0</isObjectLinked>
  <hasHierarchy>0</hasHierarchy>
  </it>
<it>
  <k>5</k>
  <id>VERSION</id>
  <n>Version</n>
  <vis>0</vis>
  <predefined>Version</predefined>
  <dt>2</dt>
  <kind>Predefined</kind>
  <nullable>0</nullable>
  <hasMultipleValues>0</hasMultipleValues>
  <readAccess />
  <writeAccess />
  <timeDependent>0</timeDependent>
  <tag />
  <visibleForEdit>0</visibleForEdit>
  <isTranslation>0</isTranslation>
  <dataDomain>0</dataDomain>
  <defExpr />
  <isObjectLinked>0</isObjectLinked>
  <hasHierarchy>0</hasHierarchy>
  </it>
<it>
  <k>6</k>
  <id>INDATE</id>
  <n>Start date</n>
  <vis>0</vis>
  <predefined>InDate</predefined>
  <dt>4</dt>
  <kind>Predefined</kind>
  <nullable>0</nullable>
  <hasMultipleValues>0</hasMultipleValues>
  <readAccess />
  <writeAccess />
  <timeDependent>0</timeDependent>
  <tag />
  <visibleForEdit>0</visibleForEdit>
  <isTranslation>0</isTranslation>
  <dataDomain>0</dataDomain>
  <defExpr />
  <isObjectLinked>0</isObjectLinked>
  <hasHierarchy>0</hasHierarchy>
  </it>
<it>
  <k>7</k>
  <id>OUTDATE</id>
  <n>End date</n>
  <vis>0</vis>
  <predefined>OutDate</predefined>
  <dt>4</dt>
  <kind>Predefined</kind>
  <nullable>0</nullable>
  <hasMultipleValues>0</hasMultipleValues>
  <readAccess />
  <writeAccess />
  <timeDependent>0</timeDependent>
  <tag />
  <visibleForEdit>0</visibleForEdit>
  <isTranslation>0</isTranslation>
  <dataDomain>0</dataDomain>
  <defExpr />
  <isObjectLinked>0</isObjectLinked>
  <hasHierarchy>0</hasHierarchy>
  </it>
  </its>
  </attrs>
<db ds="" isShortcut="0" isLink="0" ver="2" hf="0">
  <i>DB</i>
  <n>Database</n>
  <k>56</k>
  <c>513</c>
  <p>12363</p>
  <h>0</h>
  <hasPrv>0</hasPrv>
  <ic>0</ic>
  <trackElementDependents>0</trackElementDependents>
  </db>
<links>
  <its />
  </links>
<params>
<its>
<it>
  <k>1</k>
  <id>CURDATE</id>
  <n>Actuality date</n>
  <vis>1</vis>
  <predefined>CurDate</predefined>
  <skipOnNull>0</skipOnNull>
  </it>
  </its>
  </params>
<translations>
  <its />
  <isON>0</isON>
  </translations>
<levels>
  <its />
  </levels>
<importSchemas>
  <its />
  </importSchemas>
<exportSchemas>
  <its />
  </exportSchemas>
<uniqueKeys>
<its>
<it>
  <k>0</k>
  <id>PREDEFINED</id>
  <n>PREDEFINED</n>
  <vis>1</vis>
  <hidden>1</hidden>
  <useInSelection>0</useInSelection>
  <caseSensitive>1</caseSensitive>
  </it>
  </its>
  </uniqueKeys>
<nonUniqueKeys>
  <its />
  </nonUniqueKeys>
  <timeDependency>TimeReadOnly</timeDependency>
  <eeCallback />
  <isHierarchical>1</isHierarchical>
  <isSecured>0</isSecured>
  <manageVisibility>0</manageVisibility>
  <isCompound>0</isCompound>
  <isBigDictionary>0</isBigDictionary>
  <hasMandatoryAccess>0</hasMandatoryAccess>
  <hasDimMultipleValues>1</hasDimMultipleValues>
  <defaultElementKey>-1</defaultElementKey>
  <isAbacSecured>0</isAbacSecured>
  </meta>
  </GetRdsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetRds" : 
  {
   "tRds" : 
    {
     "id" : "S1!M!S!N2"
    },
   "tArg" : 
    {
     "pattern" : 
      {
       "obInst" : "true",
       "all" : "true"
      }
    }
  }
}

JSON response:

{
 "GetRdsResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!N2"
    },
   "meta" : 
    {
     "obInst" : 
      {
       "obDesc" : 
        {
         "@ds" : "",
         "@isShortcut" : "0",
         "@isLink" : "0",
         "@ver" : "4",
         "@hf" : "0",
         "i" : "FACT_ELEMENTS",
         "n" : "Dictionary with indicators",
         "k" : "219797",
         "c" : "3076",
         "p" : "5611",
         "h" : "0",
         "hasPrv" : "0",
         "ic" : "0",
         "trackElementDependents" : "0",
         "isPermanent" : "1",
         "isTemp" : "0"
        }
      },
     "dirty" : "0",
     "attrs" : 
      {
       "its" : 
        {
         "it" : 
          [
            {
             "k" : "1",
             "id" : "KEY",
             "n" : "Key",
             "vis" : "0",
             "predefined" : "Key",
             "dt" : "2",
             "kind" : "Predefined",
             "nullable" : "0",
             "hasMultipleValues" : "0",
             "readAccess" : "",
             "writeAccess" : "",
             "timeDependent" : "0",
             "tag" : "",
             "visibleForEdit" : "0",
             "isTranslation" : "0",
             "dataDomain" : "0",
             "defExpr" : "",
             "isObjectLinked" : "0",
             "hasHierarchy" : "0"
            },
            {
             "k" : "2",
             "id" : "NAME",
             "n" : "Name",
             "vis" : "1",
             "predefined" : "Name",
             "dt" : "1",
             "kind" : "Predefined",
             "nullable" : "0",
             "hasMultipleValues" : "0",
             "readAccess" : "",
             "writeAccess" : "",
             "timeDependent" : "0",
             "tag" : "",
             "visibleForEdit" : "1",
             "isTranslation" : "0",
             "dataDomain" : "0",
             "defExpr" : "",
             "isObjectLinked" : "0",
             "hasHierarchy" : "0"
            },
            {
             "k" : "3",
             "id" : "PARENT_KEY",
             "n" : "Owner",
             "vis" : "0",
             "predefined" : "ParentKey",
             "dt" : "2",
             "kind" : "Predefined",
             "nullable" : "1",
             "hasMultipleValues" : "0",
             "readAccess" : "",
             "writeAccess" : "",
             "timeDependent" : "0",
             "tag" : "",
             "visibleForEdit" : "0",
             "isTranslation" : "0",
             "dataDomain" : "0",
             "defExpr" : "",
             "isObjectLinked" : "0",
             "hasHierarchy" : "0"
            },
            {
             "k" : "4",
             "id" : "ORD",
             "n" : "Order",
             "vis" : "0",
             "predefined" : "Order",
             "dt" : "2",
             "kind" : "Predefined",
             "nullable" : "0",
             "hasMultipleValues" : "0",
             "readAccess" : "",
             "writeAccess" : "",
             "timeDependent" : "0",
             "tag" : "",
             "visibleForEdit" : "0",
             "isTranslation" : "0",
             "dataDomain" : "0",
             "defExpr" : "",
             "isObjectLinked" : "0",
             "hasHierarchy" : "0"
            },
            {
             "k" : "5",
             "id" : "VERSION",
             "n" : "Version",
             "vis" : "0",
             "predefined" : "Version",
             "dt" : "2",
             "kind" : "Predefined",
             "nullable" : "0",
             "hasMultipleValues" : "0",
             "readAccess" : "",
             "writeAccess" : "",
             "timeDependent" : "0",
             "tag" : "",
             "visibleForEdit" : "0",
             "isTranslation" : "0",
             "dataDomain" : "0",
             "defExpr" : "",
             "isObjectLinked" : "0",
             "hasHierarchy" : "0"
            },
            {
             "k" : "6",
             "id" : "INDATE",
             "n" : "Start date",
             "vis" : "0",
             "predefined" : "InDate",
             "dt" : "4",
             "kind" : "Predefined",
             "nullable" : "0",
             "hasMultipleValues" : "0",
             "readAccess" : "",
             "writeAccess" : "",
             "timeDependent" : "0",
             "tag" : "",
             "visibleForEdit" : "0",
             "isTranslation" : "0",
             "dataDomain" : "0",
             "defExpr" : "",
             "isObjectLinked" : "0",
             "hasHierarchy" : "0"
            },
            {
             "k" : "7",
             "id" : "OUTDATE",
             "n" : "End date",
             "vis" : "0",
             "predefined" : "OutDate",
             "dt" : "4",
             "kind" : "Predefined",
             "nullable" : "0",
             "hasMultipleValues" : "0",
             "readAccess" : "",
             "writeAccess" : "",
             "timeDependent" : "0",
             "tag" : "",
             "visibleForEdit" : "0",
             "isTranslation" : "0",
             "dataDomain" : "0",
             "defExpr" : "",
             "isObjectLinked" : "0",
             "hasHierarchy" : "0"
            }
          ]
        }
      },
     "db" : 
      {
       "@ds" : "",
       "@isShortcut" : "0",
       "@isLink" : "0",
       "@ver" : "2",
       "@hf" : "0",
       "i" : "DB",
       "n" : "Database",
       "k" : "56",
       "c" : "513",
       "p" : "12363",
       "h" : "0",
       "hasPrv" : "0",
       "ic" : "0",
       "trackElementDependents" : "0"
      },
     "links" : 
      {
       "its" : ""
      },
     "params" : 
      {
       "its" : 
        {
         "it" : 
          [
            {
             "k" : "1",
             "id" : "CURDATE",
             "n" : "Actuality date",
             "vis" : "1",
             "predefined" : "CurDate",
             "skipOnNull" : "0"
            }
          ]
        }
      },
     "translations" : 
      {
       "its" : "",
       "isON" : "0"
      },
     "levels" : 
      {
       "its" : ""
      },
     "importSchemas" : 
      {
       "its" : ""
      },
     "exportSchemas" : 
      {
       "its" : ""
      },
     "uniqueKeys" : 
      {
       "its" : 
        {
         "it" : 
          [
            {
             "k" : "0",
             "id" : "PREDEFINED",
             "n" : "PREDEFINED",
             "vis" : "1",
             "hidden" : "1",
             "useInSelection" : "0",
             "caseSensitive" : "1"
            }
          ]
        }
      },
     "nonUniqueKeys" : 
      {
       "its" : ""
      },
     "timeDependency" : "TimeReadOnly",
     "eeCallback" : "",
     "isHierarchical" : "1",
     "isSecured" : "0",
     "manageVisibility" : "0",
     "isCompound" : "0",
     "isBigDictionary" : "0",
     "hasMandatoryAccess" : "0",
     "hasDimMultipleValues" : "1",
     "defaultElementKey" : "4294967295",
     "isAbacSecured" : "0"
    }
  }
}
public static GetRdsResult GetRDSInfo(RdsId moniker)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tGet = new GetRds()
    {
        tArg = new GetRdsArg()
        {
            pattern = new RdsMdPattern() 
            {
                all = true
            }
        },
        tRds = moniker
    };
    //Get dictionary information
    var result = somClient.GetRds(tGet);
    return result;
}

See also:

Working with MDM Dictionaries