GetDashboardRelationship

Syntax

DashboardRelationship GetDashboardRelationship(string mon, DashboardRelationship tArg)

Parameters

mon. Moniker for working with a relation.

tArg. Operation execution parameters.

Description

The GetDashboardRelationship operation gets relation settings.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance with the !Sources!data source!Relationships!relation key postfix, and in the tArg field specify empty values or default values for the fields, which values should be obtained. Specify one element for collections. The moniker can be obtained on executing the OpenDashboard operation.

The operation results in the obtained relation settings.

Example

Below is the example of getting relation settings. The request contains the relation moniker and the list of settings, which values should be obtained. The response contains the obtained settings values.

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">
<GetDashboardRelationship xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">LKACHLFPHPFFGOAEFAJMIHOHCKLEPLKEEIENANDBMODOBJMH!M!S!PHOONDMFPHPFFGOAEGILOHDKLDDEDFAAEEJAAJAMKHGKPJBCK!Sources!1!Relationships!4</mon>
<tArg xmlns="">
  <k>4</k>
<its>
  <it />
  </its>
  </tArg>
  </GetDashboardRelationship>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDashboardRelationshipResult 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">
  <k xmlns="">4</k>
<its xmlns="">
  <it />
<it>
  <numField>1</numField>
  <formula>T.DOWN.PREV</formula>
  </it>
  </its>
  </GetDashboardRelationshipResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetDashboardRelationship" :
{
"mon" : "LKACHLFPHPFFGOAEFAJMIHOHCKLEPLKEEIENANDBMODOBJMH!M!S!PHOONDMFPHPFFGOAEGILOHDKLDDEDFAAEEJAAJAMKHGKPJBCK!Sources!1!Relationships!4",
"tArg" :
{
"k" : "4",
"its" :
{
"it" :
[
""
]
}
}
}
}

JSON response:

{
"GetDashboardRelationshipResult" :
{
"k" : "4",
"its" :
{
"it" :
[
"",
{
"numField" : "1",
"formula" : "T.DOWN.PREV"
}
]
}
}
}
public static DashboardRelationship GetDashboardRelationship(string moniker, uint sourceKey, uint relKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetDashboardRelationship()
{
tArg = new DashboardRelationship()
{
k = relKey,
its = new DashboardDimensionRelation[] { new DashboardDimensionRelation() }
},
// Moniker for working with relation
mon = moniker + "!Sources!" + sourceKey + "!Relationships!" + relKey
};
// Get relation settings
var result = somClient.GetDashboardRelationship(tGet);
return result;
}

See also:

Working with Information Panels