GetFieldValues

Syntax

GetFieldValuesResult GetFieldValues(OdId tOb, GetFieldValuesArg tArg)

Parameters

tOb. Moniker of opened relational object instance.

tArg. Operation execution parameters.

Description

The GetFieldValues operation gets unique values of the field to be used in autofilter.

Comments

Before executing this operation, the CreateFieldFilterState operation must be executed for the corresponding field. To execute the GetFieldValues operation, in the tOb field specify moniker of opened relational object instance, and in the tArg.pattern field specify the patter that will be used to get unique field values. The moniker can be obtained on executing the OpenTable, OpenQuery operations. In tArg one should also set moniker of the relation object cache that can be obtained using the GetTable/GetQuery operations with the cachedDataset field specified in the pattern.

The operation results in the obtained unique values of relational data source field.

The SetFieldFilter operation is used to use autofilter values. The made changes are applied after executing the CloseFieldFilterState operation. To get filtered records from the relational data source, call the GetTable/GetQuery operations again.

Example

It is assumed that there is the table opened for view, table moniker and table cache moniker are obtained. The table contains a field with the REGION identifier.

Below is the example of getting unique table field values that can be used in autofilter. The request contains two monikers, field identifier, and the searched value. The response contains the obtained unique field values containing the searched value.

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">
<GetFieldValues xmlns="http://www.fsight.ru/PP.SOM.Som">
<tOb xmlns="">
  <id>NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!TABLECMPCMBCJHDEIGOAEHNKFEHGJCOOAFFIEIJCFENIDGAPBKEPP</id>
  </tOb>
<tArg xmlns="">
<pattern>
  <columnId>REGION</columnId>
<cachedDatasetId>
  <id>NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!CACHEDDATASETOKBHDCCJHDEIGOAEPEALCLNDILEJPILEBJGJBCLICJLOHKBD</id>
  </cachedDatasetId>
  <search>krai</search>
<range>
  <start>0</start>
  <count>20</count>
  </range>
  </pattern>
  </tArg>
  </GetFieldValues>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetFieldValuesResult 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>NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!TABLECMPCMBCJHDEIGOAEHNKFEHGJCOOAFFIEIJCFENIDGAPBKEPP</id>
  </id>
<values xmlns="">
<it>
  <v>Altay krai</v>
  <selected>1</selected>
  </it>
<it>
  <v>Zabaykalsky krai</v>
  <selected>1</selected>
  </it>
<it>
  <v>Kamchatka krai</v>
  <selected>1</selected>
  </it>
<it>
  <v>Krasnodar krai</v>
  <selected>1</selected>
  </it>
<it>
  <v>Krasnoyarsk krai</v>
  <selected>1</selected>
  </it>
<it>
  <v>Perm krai</v>
  <selected>1</selected>
  </it>
<it>
  <v>Primorsky krai</v>
  <selected>1</selected>
  </it>
<it>
  <v>Stavropol krai</v>
  <selected>1</selected>
  </it>
<it>
  <v>Khabarovsk krai</v>
  <selected>1</selected>
  </it>
  </values>
  <total xmlns="">9</total>
  <selectAllState xmlns="">All</selectAllState>
  </GetFieldValuesResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetFieldValues" : 
  {
   "tOb" : 
    {
     "id" : "NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!TABLECMPCMBCJHDEIGOAEHNKFEHGJCOOAFFIEIJCFENIDGAPBKEPP"
    },
   "tArg" : 
    {
     "pattern" : 
      {
       "columnId" : "REGION",
       "cachedDatasetId" : 
        {
         "id" : "NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!CACHEDDATASETOKBHDCCJHDEIGOAEPEALCLNDILEJPILEBJGJBCLICJLOHKBD"
        },
       "search" : "krai",
       "range" : 
        {
         "start" : "0",
         "count" : "20"
        }
      }
    }
  }
}

JSON response:

{
 "GetFieldValuesResult" : 
  {
   "id" : 
    {
     "id" : "NLDGBACJHDEIGOAEOJMGHOOJDGJFPBFEFJEKHLKPOKBAEPOF!M!S!TABLECMPCMBCJHDEIGOAEHNKFEHGJCOOAFFIEIJCFENIDGAPBKEPP"
    },
   "values" : 
    {
     "it" : 
      [
        {
         "v" : "Altai krai",
         "selected" : "1"
        },
        {
         "v" : "Zabaykalsky krai",
         "selected" : "1"
        },
        {
         "v" : "Kamchatka krai",
         "selected" : "1"
        },
        {
         "v" : "Krasnodar krai",
         "selected" : "1"
        },
        {
         "v" : "Kransoyarsk krai",
         "selected" : "1"
        },
        {
         "v" : "Perm krai",
         "selected" : "1"
        },
        {
         "v" : "Primorsky krai",
         "selected" : "1"
        },
        {
         "v" : "Stavropol krai",
         "selected" : "1"
        },
        {
         "v" : "Khabarovsk krai",
         "selected" : "1"
        }
      ]
    },
   "total" : "9",
   "selectAllState" : "All"
  }
}
public static GetFieldValuesResult GetFieldValues(string tableMoniker, string tableCacheMoniker, string fieldId)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetFieldValues()
    {
        tArg = new GetFieldValuesArg()
        {
            pattern = new FieldValuesPattern()
            {
                cachedDatasetId = new OdId() { id = tableCacheMoniker },
                columnId = fieldId,
                range = new ListRange() { count = 20, start = 0 },
                search = "krai"
            }
        },
        tOb = new OdId() { id = tableMoniker }
    };
    // Get unique field values
    var result = somClient.GetFieldValues(tGet);
    return result;
}

See also:

Working with Relational Objects of Repository