GetPrxMeta: Операция

mon. Моникёр открытого экземпляра регламентного отчёта.

Описание

Операция GetPrxMeta извлекает метаданные регламентного отчёта.

Комментарии

Операция позволяет получить настройки различных элементов регламентного отчёта. Для выполнения операции укажите в поле mon моникёр открытого экземпляра регламентного отчёта, а в поле tArg параметры извлечения метаданных.

Моникёр может быть получен при выполнении операции OpenPrxMeta.

В поле tArg.meta задайте пустые значения или значения по умолчанию для тех полей, значения которых необходимо получить. Для коллекций укажите один элемент. Для получения информации о каком-либо конкретном элементе регламентного отчёта укажите его ключ в метаданных. При указании в качестве ключа значения «-1» будет получена информация обо всех элементах данного типа.

Пример

Ниже приведён пример получения информации о листах регламентного отчёта. В запросе передаётся моникёр для работы с регламентным отчётом и список полей, значения которых необходимо получить. В ответе приходит запрошенная информация.

SOAP JSONC#

SOAP-запрос:

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

<meta>

<its>

<it>

<n />

<type>Table</type>

</it>

</its>

</sheets>

</meta>

</tArg>

</GetPrxMeta>

</s:Body>

</s:Envelope>

SOAP-ответ:

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

<soapenv:Body>

</id>

<its>

<it>

<n>Данные</n>

<type>Table</type>

</it>

</its>

</sheets>

</meta>

</GetPrxMetaResult>

</soapenv:Body>

</soapenv:Envelope>

JSON-запрос:

{
 "GetPrxMeta" : 
  {
   "mon" : "S1!M!S!P1",
   "tArg" : 
    {
     "meta" : 
      {
       "sheets" : 
        {
         "its" : 
          {
           "it" : 
            [
              {
               "k" : "-1",
               "n" : "",
               "type" : "Table"
              }
            ]
          }
        }
      }
    }
  }
}

JSON-ответ:

{
 "GetPrxMetaResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!P1"
    },
   "meta" : 
    {
     "sheets" : 
      {
       "its" : 
        {
         "it" : 
          [
            {
             "k" : "1",
             "n" : "Данные",
             "type" : "Table"
            }
          ]
        }
      }
    }
  }
}

public static PrxMetaResult GetPrxSheets(string moniker)
{
    var somClient = new SomPortTypeClient(); //Прокси-объект для выполнения операций
    //Параметры выполнения операции
    var tGet = new GetPrxMeta()
    {
        tArg = new PrxMetaArg()
        {
            meta = new PrxMetaData()
            {
                sheets = new PrxMetaSheets() 
                {
                    its = new PrxMetaSheet[1]
                    {
                        new PrxMetaSheet() { k = ulong.MaxValue, n= "", type = PrxSheetType.Table }
                    }
                }
            }
        },
        mon = moniker
    };
    //Получение информации о листах отчёта
    var result = somClient.GetPrxMeta(tGet);
    return result;
}

GetPrxMeta

Синтаксис