CloseAdHoc: Operation

To execute the operation, in the tAdHocId field specify the dashboard instance moniker to be closed. The operation results in the logical True if the object was closed successfully.

Example

The example of closing a dashboard instance. The request contains the dashboard moniker. The response contains whether closing is 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">

<id>S1!M!S!AdHoc1</id>

</tAdHocId>

</CloseAdHoc>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "CloseAdHoc" : 
  {
   "tAdHocId" : 
    {
     "id" : "S1!M!S!AdHoc1"
    }
  }
}

JSON response:

{
 "CloseAdHocResult" : "1"
}

The CloseAdhoc function specified below closes the dashboard instance and returns whether the closing was successful. The dashboard moniker is sent as a function input parameter.

public static bool CloseAdhoc(AdHocId moniker)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tClose = new CloseAdHoc()
    {
        tAdHocId = moniker
    };
    //Close dashboard
    var result = somClient.CloseAdHoc(tClose);
    return result;
}

CloseAdHoc

Syntax

Parameters

Description

Comments

Example

SOAP request:

SOAP response:

JSON request:

JSON response: