GetBpmStep

Syntax

BpmStep GetBpmStep(BpmProcessId tBpmProcess, BpmStepArg tBpmStepArg)

Parameters

tBpmProcess. Moniker of opened process.

tBpmStepArg. Operation execution parameters.

Description

The GetBpmStep operation gets process step settings.

Comments

To execute the operation, in the tBpmProcess field specify moniker of opened process, and in the tBpmStepArg field specify get settings parameters. The moniker can be obtained after executing the OpenBpmProcess operation. In the tBpmStepArg.bindOpt.optType field specify the settings that should be obtained. In the tBpmStepArg.guid field specify step's unique identifier. The unique identifier can be obtained in execution results of the GetBpmWorkspace operation. Use the tBpmStepArg.objBind, tBpmStepArg.stepType fields to get settings of links with process parameters.

The operation results in the obtained step settings.

Example

Below is the example of getting basic step settings. The request contains moniker of opened process and step unique identifier. The response contains the obtained settings.

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">
<GetBpmStep xmlns="http://www.fsight.ru/PP.SOM.Som">
<tBpmProcess xmlns="">
  <id>HCCHPFCEOKKEGOAEIEHCIOKNOCLDDHIEFIHLKFNHGNCKFAMP!M!S!BPKGCGEJCEOKKEGOAEJBOMCNNAIOMLLLCEELEHEIIOADLCIINK</id>
  </tBpmProcess>
<tBpmStepArg xmlns="">
  <guid>{354F963A-8195-461E-BC49-CC14F1E64F92}</guid>
<bindOpt>
  <optType>Base</optType>
  </bindOpt>
  </tBpmStepArg>
  </GetBpmStep>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmStepResult 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">
  <isEnabled xmlns="">0</isEnabled>
  <isValid xmlns="">1</isValid>
  <name xmlns="">New step name</name>
  <type xmlns="">ManualTask</type>
  <index xmlns="">1</index>
  <guid xmlns="">{354F963A-8195-461E-BC49-CC14F1E64F92}</guid>
  <descr xmlns="">Step is temporarily excluded from calculation</descr>
  <roleId xmlns="">PS-1-1</roleId>
  <roleName xmlns="">ADMIN</roleName>
<maxDur xmlns="">
  <periodType>Day</periodType>
  <amount>1</amount>
  </maxDur>
  <minDeadline xmlns="">18:00</minDeadline>
  <checkDeadline xmlns="">0</checkDeadline>
  </GetBpmStepResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetBpmStep" :
{
"tBpmProcess" :
{
"id" : "HCCHPFCEOKKEGOAEIEHCIOKNOCLDDHIEFIHLKFNHGNCKFAMP!M!S!BPKGCGEJCEOKKEGOAEJBOMCNNAIOMLLLCEELEHEIIOADLCIINK"
},
"tBpmStepArg" :
{
"guid" : "{354F963A-8195-461E-BC49-CC14F1E64F92}",
"bindOpt" :
{
"optType" : "Base"
}
}
}
}

JSON response:

{
"GetBpmStepResult" :
{
"isEnabled" : "0",
"isValid" : "1",
"name" : "New step name",
"type" : "ManualTask",
"index" : "1",
"guid" : "{354F963A-8195-461E-BC49-CC14F1E64F92}",
"descr" : "Step is temporarily excluded from calculation",
"roleId" : "PS-1-1",
"roleName" : "ADMIN",
"maxDur" :
{
"periodType" : "Day",
"amount" : "1"
},
"minDeadline" : "18:00",
"checkDeadline" : "0"
}
}
public static BpmStep GetBpmStep(string moniker, string stepGUID, BpmStepOptionType optionType = BpmStepOptionType.Base)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmStep()
{
tBpmProcess = new BpmProcessId() { id = moniker },
tBpmStepArg = new BpmStepArg()
{
bindOpt = new BpmBindingParamOption()
{
optType = optionType
},
guid = stepGUID
}
};
// Get information about step
var result = somClient.GetBpmStep(tGet);
return result;
}

See also:

Working with Processes