HandleCustomObOper: Operation

HandleCustomObOperResult HandleCustomObOper(OdId tObj, HandleCustomObOperArg tArg)

Parameters

Description

The HandleCustomObOper operation is used to execute custom/standard operation for custom class object instance.

Comments

To execute the operation, in the tObj field specify moniker of custom class object instance, in the tArg.operationId field specify identifier of custom/standard class operation. The moniker can be obtained on executing the CreateCustomOb, OpenCustomOb operation. The executed operation identifier can be obtained in custom class metadata that can be obtained on executing the OpenCustomExtender, GetCustomExtender operations.

The HandleCustomObOper operation returns the result of executing custom/standard operation.

Example

Below is the example of executing custom operation for custom class object instance. The request contains moniker of opened instance of custom object and identifier of the executed operation. The response contains operation execution result.

SOAP JSON C#

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>KIJGJLGLBNIEGOAEKKDNNHHCKMKIANEEPIGPOKBNCCCNDLDC!M!S!OGJDCJCHLBNIEGOAEEJEBKIOHBNBIFPPEIIEEIAFBMGNGGONL</id>

</tObj>

<operationId>EXPORT</operationId>

</tArg>

</HandleCustomObOper>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</webFormResult>

<id>KIJGJLGLBNIEGOAEKKDNNHHCKMKIANEEPIGPOKBNCCCNDLDC!M!S!OGJDCJCHLBNIEGOAEEJEBKIOHBNBIFPPEIIEEIAFBMGNGGONL</id>

</id>

<n>Custom object</n>

</object>

</HandleCustomObOperResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "HandleCustomObOper" : 
  {
   "tObj" : 
    {
     "id" : "KIJGJLGLBNIEGOAEKKDNNHHCKMKIANEEPIGPOKBNCCCNDLDC!M!S!OGJDCJCHLBNIEGOAEEJEBKIOHBNBIFPPEIIEEIAFBMGNGGONL"
    },
   "tArg" : 
    {
     "operationId" : "EXPORT"
    }
  }
}

JSON response:

{
 "HandleCustomObOperResult" : 
  {
   "webFormResult" : 
    {
     "handlerKey" : "10101"
    },
   "id" : 
    {
     "id" : "KIJGJLGLBNIEGOAEKKDNNHHCKMKIANEEPIGPOKBNCCCNDLDC!M!S!OGJDCJCHLBNIEGOAEEJEBKIOHBNBIFPPEIIEEIAFBMGNGGONL"
    },
   "object" : 
    {
     "@ds" : "",
     "@isShortcut" : "0",
     "@isLink" : "0",
     "@ver" : "2",
     "@hf" : "0",
     "i" : "OBJ10106",
     "n" : "Custom object",
     "k" : "10106",
     "c" : "2168577",
     "p" : "10099",
     "h" : "0",
     "hasPrv" : "0",
     "ic" : "0",
     "trackElementDependents" : "0"
    }
  }
}

public static HandleCustomObOperResult HandleCustomObOper(string objMoniker, string operation)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tClose = new HandleCustomObOper()
    {
        tObj = new OdId() { id = objMoniker },
        tArg = new HandleCustomObOperArg() { operationId = operation }
    };
    // Execute operation for custom class object instance
    var tResult = somClient.HandleCustomObOper(tClose);
    return tResult;
}

HandleCustomObOper

Syntax