GetProcessInstances: Operation

GetProcessInstancesResult GetProcessInstances(BpmProcessId tBpmProcess, BProcessInstancesArg arg)

Parameters

Description

Comments

To execute the operation, in the tBpmProcess field specify moniker of opened process instance. The moniker can be obtained after executing the OpenBpmProcess operation. If it is required to get a list of processes executed within a subprocess, specify identifier of the subprocess instance in the arg.parentInstId field.

Example

Below is the example of getting a list of executed process instances. The request contains moniker of opened process instance. The response contains the obtained information.

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>CDIKMKCKEHJCGOAELMMPKEGKAJIPBMFELKNPPPKHHFAHIIHI!M!S!BPFGPGKNCKEHJCGOAEHJDEHIPJFHBPODGEKJCMFANHBFPHKIDC</id>

</tBpmProcess>

<mode>Default</mode>

</arg>

</GetProcessInstances>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

<it>

<prms>Dictionary = '1'</prms>

</it>

</list>

</GetProcessInstancesResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetProcessInstances" : 
  {
   "tBpmProcess" : 
    {
     "id" : "CDIKMKCKEHJCGOAELMMPKEGKAJIPBMFELKNPPPKHHFAHIIHI!M!S!BPFGPGKNCKEHJCGOAEHJDEHIPJFHBPODGEKJCMFANHBFPHKIDC"
    },
   "arg" : 
    {
     "mode" : "Default"
    }
  }
}

JSON response:

{
 "GetProcessInstancesResult" : 
  {
   "operations" : "1",
   "list" : 
    {
     "it" : 
      {
       "key" : "51021",
       "startDate" : "31.03.2024 17:14:38",
       "comment" : "",
       "prms" : "Dictionary = '1'"
      }
    }
  }
}

public static GetProcessInstancesResult GetProcessInstances(string moniker)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetProcessInstances()
    {
        tBpmProcess = new BpmProcessId() { id = moniker },
        arg = new BProcessInstancesArg() { mode = BProcessInstanceMode.Default }
    };
    // Get a list of executed instances of the specified process
    var result = somClient.GetProcessInstances(tGet);
    return result;
}

GetProcessInstances

Syntax