GetBpmStepOperations

Syntax

BpmStepOperationStatusResult GetBpmStepOperations(BpmProcessId tBpmProcess, GetBpmStepOperationsArg tArg)

Parameters

tBpmProcess. Moniker of opened process.

tArg. Operation execution parameters.

Description

The GetBpmStepOperations operation gets a list of operations available for step of executed process instance.

Comments

To execute the operation, in the tBpmProcess field specify moniker of opened process. The moniker can be obtained after executing the OpenBpmProcess operation. In the tArg.instId field specify unique key of executed process instance. The key is available in the list collection of execution results of the GetProcessInstances operation. In the tArg.guids field specify step GUIDs. GUIDs can be obtained using the GetBpmMonitoringWorkspace operation.

The operation results in the collection of elements with information about operations available for steps.

Example

Below is the example of a list of operations available for executed process steps. The request contains moniker of opened process, process instance key, and step GUIDs. The response contains the obtained list of available steps.

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">
<GetBpmStepOperations xmlns="http://www.fsight.ru/PP.SOM.Som">
<tBpmProcess xmlns="">
  <id>MGJFJPPOBBDDGOAECMABJPKINDGPEBIEBLJDEKDGIANBKOGK!M!S!BPIMOEODAPBBDDGOAEDHLCADLCMDDIJDCEGJPKIJEBEEOLAHIL</id>
  </tBpmProcess>
<tArg xmlns="">
  <instId>98037</instId>
<guids>
  <it>{17AE01A0-8BDA-4B2C-8BF3-B48A6A411EE1}</it>
  <it>{9EE92EA8-E209-45D5-B662-7063A93FA887}</it>
  </guids>
  </tArg>
  </GetBpmStepOperations>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmStepOperationsResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<steps xmlns="">
<it>
  <guid>{17AE01A0-8BDA-4B2C-8BF3-B48A6A411EE1}</guid>
<ops>
  <it>1</it>
  <it>8</it>
  </ops>
<bindParams>
<it>
  <paramId>OBJ168001_0</paramId>
  <dimKey>168001</dimKey>
  <mnk>MGJFJPPOBBDDGOAECMABJPKINDGPEBIEBLJDEKDGIANBKOGK!M!S!SBBHMKLAPBBDDGOAEGNHJGINPEEBHEKOELIIFKIFHGFHIKGML</mnk>
  </it>
  </bindParams>
  <autoExec>0</autoExec>
  </it>
<it>
  <guid>{9EE92EA8-E209-45D5-B662-7063A93FA887}</guid>
  <ops />
  <bindParams />
  <autoExec>0</autoExec>
  </it>
  </steps>
  </GetBpmStepOperationsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetBpmStepOperations" :
{
"tBpmProcess" :
{
"id" : "MGJFJPPOBBDDGOAECMABJPKINDGPEBIEBLJDEKDGIANBKOGK!M!S!BPIMOEODAPBBDDGOAEDHLCADLCMDDIJDCEGJPKIJEBEEOLAHIL"
},
"tArg" :
{
"instId" : "98037",
"guids" :
{
"it" :
[
"{17AE01A0-8BDA-4B2C-8BF3-B48A6A411EE1}",
"{9EE92EA8-E209-45D5-B662-7063A93FA887}"
]
}
}
}
}

JSON response:

{
"GetBpmStepOperationsResult" :
{
"steps" :
{
"it" :
[
{
"guid" : "{17AE01A0-8BDA-4B2C-8BF3-B48A6A411EE1}",
"ops" :
{
"it" :
[
"1",
"8"
]
},
"bindParams" :
{
"it" :
{
"paramId" : "OBJ168001_0",
"dimKey" : "168001",
"mnk" : "MGJFJPPOBBDDGOAECMABJPKINDGPEBIEBLJDEKDGIANBKOGK!M!S!SBBHMKLAPBBDDGOAEGNHJGINPEEBHEKOELIIFKIFHGFHIKGML"
}
},
"autoExec" : "0"
},
{
"guid" : "{9EE92EA8-E209-45D5-B662-7063A93FA887}",
"ops" : "",
"bindParams" : "",
"autoExec" : "0"
}
]
}
}
}
public static BpmStepOperationStatusResult GetBpmStepOperations(string moniker, int instanceKey, string[] stepGUIDs)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmStepOperations()
{
tBpmProcess = new BpmProcessId() { id = moniker },
tArg = new GetBpmStepOperationsArg()
{
instId = instanceKey,
guids = stepGUIDs
}
};
// Get a list of operations available for steps of executed process instance
var result = somClient.GetBpmStepOperations(tGet);
return result;
}

See also:

Working with Processes