BpmSegmentsForStepsResult GetBpmSegmentsForSteps(BpmProcessId tBpmProcess, BpmSegmentsForStepsArg tArg)
tBpmProcess. Moniker of opened process instance.
tArg. Operation execution parameters.
The GetBpmSegmentsForSteps operation gets information about the segments that can be used in a step.
The operation is relevant for the Data Entry or Approval steps.
To execute the operation, in the tBpmProcess field specify moniker of opened process instance, and in the tArg field specify information about the step, for which the operation is executed. The moniker can be obtained after executing the OpenBpmProcess operation. Step information can be obtained using the GetBpmWorkspace operation.
The operation results in the obtained information about step data segments.
Below is the example of getting information about the segments that can be applied for a step. The request contains moniker of opened process instance, data entry step GUID, and data entry form key, for working with which the step is set up. The response contains information about the cube segments used in the data entry form.
{
"GetBpmSegmentsForSteps" :
{
"tBpmProcess" :
{
"id" : "FEMECGGABFLBGOAEJBJKCPGGFAHPPKEEIKOJCGNBAGIOIMIC!M!S!BPPGKHJHGABFLBGOAENCJJPOBAMGBMALIEDKIOMOCIBDCANJEA"
},
"tArg" :
{
"key" : "343818",
"isFullTree" : "true",
"stpGuid" : "{42F4DDBC-DC40-46E3-83F6-202E13E4EF37}"
}
}
}
{
"GetBpmSegmentsForStepsResult" :
{
"res" :
{
"it" :
{
"cubesName" : "Cube",
"type" : "0",
"cubeKey" : "343811",
"segs" :
{
"it" :
[
{
"segmentKey" : "343832",
"segmenteName" : "Access by sectors"
},
{
"segmentKey" : "343834",
"segmenteName" : "Access by companies"
}
]
}
}
}
}
}
public static BpmSegmentsForStepsResult GetBpmSegmentsForSteps(string moniker, string stepGUID, uint frmKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmSegmentsForSteps()
{
// Create object moniker
tBpmProcess = new BpmProcessId() { id = moniker },
tArg = new BpmSegmentsForStepsArg()
{
isFullTree = true,
stpGuid = stepGUID,
key = frmKey
}
};
// Get segment settings that can be used in step
var result = somClient.GetBpmSegmentsForSteps(tGet);
return result;
}
See also: