GetBpmProcessInstanceJournal: Operation

BpmProcessInstanceJournalResult GetBpmProcessInstanceJournal(BpmProcessId tBpmProcess, BpmProcessInstanceJournalArg tArg)

Parameters

Description

The GetBpmProcessInstanceJournal operation gets the log of process instance execution.

Comments

The operation allows for getting details about execution of specific steps during process instance execution. To execute the operation, in the tArg.instId field specify moniker of the running process instance. The key can be obtained using the GetProcessInstances operation.

The operation results in the collection of elements with information about state of executed process steps.

Example

Below is the example of getting the log of process instance execution. The request contains moniker of opened process and key of running process instance. The response contains the collection of elements with information about step state.

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>NOHBFMIMOCJDGOAECBLCHDDGCNNBKKJEGLNLEFGONIKKGFFI!M!S!BPBDGDNPIMOCJDGOAEIMBANHJGKJGKPCFEJIHKPEIHBMHADJDF</id>

</tBpmProcess>

</tArg>

</GetBpmProcessInstanceJournal>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

<it>

<name>Stage 1</name>

<steps>

<it>

<name>Manual action 1</name>

</it>

</steps>

</it>

</stages>

</GetBpmProcessInstanceJournalResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetBpmProcessInstanceJournal" : 
  {
   "tBpmProcess" : 
    {
     "id" : "NOHBFMIMOCJDGOAECBLCHDDGCNNBKKJEGLNLEFGONIKKGFFI!M!S!BPBDGDNPIMOCJDGOAEIMBANHJGKJGKPCFEJIHKPEIHBMHADJDF"
    },
   "tArg" : 
    {
     "instId" : "103307"
    }
  }
}

JSON response:

{
 "GetBpmProcessInstanceJournalResult" : 
  {
   "stages" : 
    {
     "it" : 
      {
       "name" : "Stage 1",
       "steps" : 
        {
         "it" : 
          {
           "name" : "Manual action 1",
           "status" : "2",
           "stDate" : "2024-08-09T11:05:21.000"
          }
        }
      }
    }
  }
}

public static BpmProcessInstanceJournalResult GetBpmProcessInstanceJournal(string moniker, uint processInstanceKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetBpmProcessInstanceJournal()
    {
        // Create object moniker
        tBpmProcess = new BpmProcessId() { id = moniker },
        tArg = new BpmProcessInstanceJournalArg()
        {
            instId = processInstanceKey
        }
    };
    // Get process instance execution log
    var result = somClient.GetBpmProcessInstanceJournal(tGet);
    return result;
}

GetBpmProcessInstanceJournal

Syntax