GetUpdateSettings

Syntax

ViewerUpdateSettings GetUpdateSettings(string mon)

Parameters

mon. Moniker to work with automatic update parameters.

Description

The GetUpdateSettings operation gets parameters of regular report automatic update.

Comments

To execute the operation, in the mon field specify moniker of regular report instance with the !Options!UpdateSettings postfix. The moniker can be obtained on executing the OpenPrxMeta operation.

The operation returns specified parameters of regular report automatic update.

Example

Below is the example of getting regular report automatic update parameters. Th request sends moniker to work with parameters of automatic update. The response contains requested 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">
<GetUpdateSettings xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!Options!UpdateSettings</mon>
  </GetUpdateSettings>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetUpdateSettingsResult 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">
  <updateByIntervalEnabled xmlns="">0</updateByIntervalEnabled>
  <autoUpdateByData xmlns="">1</autoUpdateByData>
  <AutoUpdateInterval xmlns="">5</AutoUpdateInterval>
  <autoUpdateIntervalUnits xmlns="">Minutes</autoUpdateIntervalUnits>
  </GetUpdateSettingsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetUpdateSettings" :
{
"mon" : "S1!M!S!P1!Options!UpdateSettings"
}
}

JSON response:

{
"GetUpdateSettingsResult" :
{
"updateByIntervalEnabled" : "0",
"autoUpdateByData" : "1",
"AutoUpdateInterval" : "5",
"autoUpdateIntervalUnits" : "Minutes"
}
}
public static ViewerUpdateSettings GetUpdateSettings(string moniker)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tGet = new GetUpdateSettings()
{
mon = moniker + "!Options!UpdateSettings"
};
//Get parameters of regular report automatic update
var result = somClient.GetUpdateSettings(tGet);
return result;
}

See also:

Working with Regular Reports