DashboardRelationshipsDelete

Syntax

bool DashboardRelationshipsDelete(string mon, OpItemKey tArg)

Parameters

mon. Moniker for working with the relations used in calculated fact formulas.

tArg. Key of deleted relation.

Description

The DashboardRelationshipsDelete operation deletes relation.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance with the !Sources!data source key!Relationships postfix, and in the tArg.k field specify the key of deleted relation. The moniker can be obtained on executing the OpenDashboard operation. The key can be obtained after executing the GetDashboardRelationships or DashboardRelationshipsAdd operation.

The operation results in the logical true if the relation was deleted successfully.

Example

Below is the example of deleting the relation. The request contains the moniker for working with relations and the key of deleted relation. The response contains whether deletion was successful.

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

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <DashboardRelationshipsDeleteResult 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">1</DashboardRelationshipsDeleteResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "DashboardRelationshipsDelete" : 
  {
   "mon" : "LKACHLFPHPFFGOAEFAJMIHOHCKLEPLKEEIENANDBMODOBJMH!M!S!PHOONDMFPHPFFGOAEGILOHDKLDDEDFAAEEJAAJAMKHGKPJBCK!Sources!1!Relationships",
   "tArg" : 
    {
     "k" : "4"
    }
  }
}

JSON response:

{
 "DashboardRelationshipsDeleteResult" : "1"
}
public static bool DashboardRelationshipsDelete(string moniker, uint sourceKey, uint relKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tDel = new DashboardRelationshipsDelete()
    {
        tArg = new OpItemKey() { k = relKey },
        // Moniker for working with relations
        mon = moniker + "!Sources!" + sourceKey + "!Relationships"
    };
    // Delete relation
    var result = somClient.DashboardRelationshipsDelete(tDel);
    return result;
}

See also:

Working with Information Panels