GetStartEventSettings: Operation

BpmStartEventInfo GetStartEventSettings(BpmProcessId tBpmProcess, GetStartEventSettingsArg tArg)

Parameters

Description

Comments

To execute the operation, in the tBpmProcess field specify moniker of opened process, and in the tArg.optType field specify type of obtained settings. The moniker can be obtained after executing the OpenBpmProcess operation.

Example

Below is the example of getting process start event settings. The request contains moniker of opened process. The response contains the obtained settings.

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>DICNGBKNAJKEGOAEPFPJHGAAEMHJPFIEHLGHCIACBBLCJJKA!M!S!BPAHEICDKNAJKEGOAECMEPDJAJDGAPEBCELJDMNJMLEPENHPHE</id>

</tBpmProcess>

</tArg>

</GetStartEventSettings>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

<type>Weekly</type>

<wPer>

<dsOfW>

</dsOfW>

</wPer>

</per>

<id xmlns="">START_TIMER_EVENT</id>

</GetStartEventSettingsResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetStartEventSettings" : 
  {
   "tBpmProcess" : 
    {
     "id" : "DICNGBKNAJKEGOAEPFPJHGAAEMHJPFIEHLGHCIACBBLCJJKA!M!S!BPAHEICDKNAJKEGOAECMEPDJAJDGAPEBCELJDMNJMLEPENHPHE"
    },
   "tArg" : 
    {
     "optType" : "0"
    }
  }
}

JSON response:

{
 "GetStartEventSettingsResult" : 
  {
   "optType" : "0",
   "per" : 
    {
     "type" : "Weekly",
     "wPer" : 
      {
       "evWs" : "1",
       "dsOfW" : 
        {
         "it" : "1"
        }
      }
    },
   "rep" : "4",
   "id" : "START_TIMER_EVENT",
   "stDT" : "2024-12-26T07:00:00.000Z"
  }
}

public static BpmStartEventInfo GetStartEventSettings(string moniker)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetStartEventSettings()
    {
        // Create object moniker
        tBpmProcess = new BpmProcessId() { id = moniker },
        tArg = new GetStartEventSettingsArg()
        {
            optType = 0
        }
    };
    // Get start event settings
    var result = somClient.GetStartEventSettings(tGet);
    return result;
}

GetStartEventSettings

Syntax