GetBpmProcessSettings

Syntax

BpmProcessSettings GetBpmProcessSettings(BpmProcessId tBpmProcess)

Parameters

tBpmProcess. Moniker of opened process instance.

Description

The GetBpmProcessSettings operation gets process settings.

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.

The operation results in the obtained process settings.

Example

Below is the example of getting process settings. The request contains moniker of opened process instance. 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">
<GetBpmProcessSettings xmlns="http://www.fsight.ru/PP.SOM.Som">
<tBpmProcess xmlns="">
  <id>PCMPFKDANKDAGOAEHGGCMAILKEKKFDIEKJCJBILJBEBFPLMF!M!S!BPGFFNKBEANKDAGOAEDJNBGLCJMDPBKHHEIKDLOLJJHKCKAIFG</id>
  </tBpmProcess>
  </GetBpmProcessSettings>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmProcessSettingsResult 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">
<baseSettings xmlns="">
  <roleId>PS-1-1</roleId>
  <adminControl>1</adminControl>
  <serviceExecution>0</serviceExecution>
  <description />
  </baseSettings>
<paramsSettings xmlns="">
<bpmProcessParams>
<it>
  <dictKey>338159</dictKey>
  <dictName>Planning version</dictName>
  </it>
  </bpmProcessParams>
  </paramsSettings>
  </GetBpmProcessSettingsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetBpmProcessSettings" :
{
"tBpmProcess" :
{
"id" : "PCMPFKDANKDAGOAEHGGCMAILKEKKFDIEKJCJBILJBEBFPLMF!M!S!BPGFFNKBEANKDAGOAEDJNBGLCJMDPBKHHEIKDLOLJJHKCKAIFG"
}
}
}

JSON response:

{
"GetBpmProcessSettingsResult" :
{
"baseSettings" :
{
"roleId" : "PS-1-1",
"adminControl" : "1",
"serviceExecution" : "0",
"description" : ""
},
"paramsSettings" :
{
"bpmProcessParams" :
{
"it" :
{
"dictKey" : "338159",
"dictName" : "Plan scenario"
}
}
}
}
}
public static BpmProcessSettings GetBpmProcessSettings(string moniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmProcessSettings()
{
// Create object moniker
tBpmProcess = new BpmProcessId() { id = moniker }
};
// Get process settings
var result = somClient.GetBpmProcessSettings(tGet);
return result;
}

See also:

Working with Processes