GetBpmGateway

Syntax

GetBpmGatewayResult GetBpmGateway(BpmProcessId tBpmProcess, GetBpmGatewayArg tArg)

Parameters

tBpmProcess. Moniker of opened process instance.

tArg. Operation execution parameters.

Description

The GetBpmGateway operation gets settings of the gateway created within a stage.

Comments

To execute the operation, in the tBpmProcess field specify moniker of opened process instance, and in the tArg.stageId field specify stage identifier. The moniker can be obtained after executing the OpenBpmProcess operation.

The operation results in the type of gateway and list of stage groups with conditions.

Example

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

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmGatewayResult 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">
<gateways xmlns="">
<it>
  <gtwType>No_gateway</gtwType>
  <isCondActive>0</isCondActive>
  <stageId>338080*0</stageId>
  </it>
  </gateways>
  </GetBpmGatewayResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetBpmGateway" :
{
"tBpmProcess" :
{
"id" : "PCMPFKDANKDAGOAEHGGCMAILKEKKFDIEKJCJBILJBEBFPLMF!M!S!BPGFFNKBEANKDAGOAEDJNBGLCJMDPBKHHEIKDLOLJJHKCKAIFG"
},
"tArg" :
{
"stageId" : "0"
}
}
}

JSON response:

{
"GetBpmGatewayResult" :
{
"gateways" :
{
"it" :
{
"gtwType" : "No_gateway",
"isCondActive" : "0",
"stageId" : "338080*0"
}
}
}
}
public static GetBpmGatewayResult GetBpmGateway(string moniker, int stage)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmGateway()
{
// Create object moniker
tBpmProcess = new BpmProcessId() { id = moniker },
tArg = new GetBpmGatewayArg() { stageId = stage }
};
// Get information about gateway
var result = somClient.GetBpmGateway(tGet);
return result;
}

See also:

Working with Processes