GetBpmWorkspace

Syntax

BpmProcessInfoResult GetBpmWorkspace(BpmProcessId tBpmProcess)

Parameters

tBpmProcess. Moniker of opened process instance.

Description

The GetBpmWorkspace operation gets information about process structure.

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 sets of stages, step settings, gateway conditions.

Example

Below is the example of getting process structure. The request contains moniker of opened process instance. The response contains the obtained information.

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">
<GetBpmWorkspace xmlns="http://www.fsight.ru/PP.SOM.Som">
<tBpmProcess xmlns="">
  <id>HBBODBAFBDNAGOAEMMDKMLHCADEHCLGEKJHCKBIALPJCLPHF!M!S!BPNDIADGAFBDNAGOAEHGKIOKHBHBJIJMIELINEGEDPGAGEIEAP</id>
  </tBpmProcess>
  </GetBpmWorkspace>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetBpmWorkspaceResult 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">
  <name xmlns="">Process 1</name>
<stages xmlns="">
<it>
<stage>
  <name>Stage 1</name>
  <index>0</index>
  <guid>{D198A63E-B5BD-4791-88F3-3E60C9DE7A54}</guid>
  </stage>
  <gtwType>No_gateway</gtwType>
  <isCondActive>0</isCondActive>
<stGroups>
<it>
<stGroup>
  <index>0</index>
  <guid>{322DDF61-B291-42CB-A075-53B7F4337743}</guid>
  </stGroup>
<steps>
<it>
  <isEnabled>1</isEnabled>
  <name>Manual data entry</name>
  <type>ManualTask</type>
  <index>0</index>
  <guid>{13F3BEEB-009D-4FF7-88CC-F3C41A025A99}</guid>
  <roleId>PS-1-144122</roleId>
<maxDur>
  <periodType>Week</periodType>
  <amount>1</amount>
  </maxDur>
  <minDeadline>17:00</minDeadline>
  <checkDeadline>1</checkDeadline>
  </it>
<it>
  <isEnabled>1</isEnabled>
  <name>Approve changes</name>
  <type>Approval</type>
  <index>1</index>
  <guid>{0CF6521D-F5DB-48EB-A310-3897914390A6}</guid>
  <roleId>PS-1-1</roleId>
<maxDur>
  <periodType>Day</periodType>
  <amount>1</amount>
  </maxDur>
  <minDeadline>18:00</minDeadline>
  <bindObjKey>340033</bindObjKey>
  <checkDeadline>1</checkDeadline>
<data>
  <writeAccess>0</writeAccess>
  <authObjKey>317058</authObjKey>
  </data>
  </it>
<it>
  <isEnabled>1</isEnabled>
  <name>Data entry</name>
  <type>DataInput</type>
  <index>2</index>
  <guid>{6334B0E6-1E9F-45AA-BBA1-7F69C53F08C3}</guid>
  <roleId>PS-1-1</roleId>
<maxDur>
  <periodType>Day</periodType>
  <amount>1</amount>
  </maxDur>
  <minDeadline>18:00</minDeadline>
  <bindObjKey>340033</bindObjKey>
  <checkDeadline>0</checkDeadline>
<data>
  <authObjKey>302417</authObjKey>
  </data>
  </it>
<it>
  <isEnabled>1</isEnabled>
  <name>ETL task</name>
  <type>EtlTask</type>
  <index>3</index>
  <guid>{97A8F45A-9E05-414C-91E5-5281769669C7}</guid>
  <roleId>PS-1-1</roleId>
<maxDur>
  <periodType>Day</periodType>
  <amount>1</amount>
  </maxDur>
  <minDeadline>18:00</minDeadline>
  <bindObjKey>340040</bindObjKey>
  <checkDeadline>0</checkDeadline>
  </it>
  </steps>
  <isDefaultFlow>0</isDefaultFlow>
  </it>
  </stGroups>
  </it>
  </stages>
<stEv xmlns="">
<it>
<per>
  <type>Monthly</type>
<mPer>
<ms>
  <it>8</it>
  </ms>
<wM>
  <wOfM>5</wOfM>
  <dOfW>1</dOfW>
  </wM>
  </mPer>
  </per>
  <rep>1</rep>
  <id>START_TIMER_EVENT</id>
  <stCom />
  <stDT>2023-08-23T09:36:18.000</stDT>
<dims>
<it>
  <pKey>338159</pKey>
<dimS>
  <mnk>HBBODBAFBDNAGOAEMMDKMLHCADEHCLGEKJHCKBIALPJCLPHF!M!S!SOMJIMIAFBDNAGOAEEGJKDPPLPDBDLAJEFLMFLGHLADJGIHMM</mnk>
  </dimS>
  </it>
  </dims>
  </it>
  </stEv>
  </GetBpmWorkspaceResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetBpmWorkspace" :
{
"tBpmProcess" :
{
"id" : "HBBODBAFBDNAGOAEMMDKMLHCADEHCLGEKJHCKBIALPJCLPHF!M!S!BPNDIADGAFBDNAGOAEHGKIOKHBHBJIJMIELINEGEDPGAGEIEAP"
}
}
}

JSON response:

{
"GetBpmWorkspaceResult" :
{
"name" : "Process 1",
"stages" :
{
"it" :
{
"stage" :
{
"name" : "Stage 1",
"index" : "0",
"guid" : "{D198A63E-B5BD-4791-88F3-3E60C9DE7A54}"
},
"gtwType" : "No_gateway",
"isCondActive" : "0",
"stGroups" :
{
"it" :
{
"stGroup" :
{
"index" : "0",
"guid" : "{322DDF61-B291-42CB-A075-53B7F4337743}"
},
"steps" :
{
"it" :
[
{
"isEnabled" : "1",
"name" : "Manual data entry",
"type" : "ManualTask",
"index" : "0",
"guid" : "{13F3BEEB-009D-4FF7-88CC-F3C41A025A99}",
"roleId" : "PS-1-144122",
"maxDur" :
{
"periodType" : "Week",
"amount" : "1"
},
"minDeadline" : "17:00",
"checkDeadline" : "1"
},
{
"isEnabled" : "1",
"name" : "Approve changes",
"type" : "Approval",
"index" : "1",
"guid" : "{0CF6521D-F5DB-48EB-A310-3897914390A6}",
"roleId" : "PS-1-1",
"maxDur" :
{
"periodType" : "Day",
"amount" : "1"
},
"minDeadline" : "18:00",
"bindObjKey" : "340033",
"checkDeadline" : "1",
"data" :
{
"writeAccess" : "0",
"authObjKey" : "317058"
}
},
{
"isEnabled" : "1",
"name" : "Data entry",
"type" : "DataInput",
"index" : "2",
"guid" : "{6334B0E6-1E9F-45AA-BBA1-7F69C53F08C3}",
"roleId" : "PS-1-1",
"maxDur" :
{
"periodType" : "Day",
"amount" : "1"
},
"minDeadline" : "18:00",
"bindObjKey" : "340033",
"checkDeadline" : "0",
"data" :
{
"authObjKey" : "302417"
}
},
{
"isEnabled" : "1",
"name" : "ETL task",
"type" : "EtlTask",
"index" : "3",
"guid" : "{97A8F45A-9E05-414C-91E5-5281769669C7}",
"roleId" : "PS-1-1",
"maxDur" :
{
"periodType" : "Day",
"amount" : "1"
},
"minDeadline" : "18:00",
"bindObjKey" : "340040",
"checkDeadline" : "0"
}
]
},
"isDefaultFlow" : "0"
}
}
}
},
"stEv" :
{
"it" :
{
"per" :
{
"type" : "Monthly",
"mPer" :
{
"ms" :
{
"it" : "8"
},
"wM" :
{
"wOfM" : "5",
"dOfW" : "1"
}
}
},
"rep" : "1",
"id" : "START_TIMER_EVENT",
"stCom" : "",
"stDT" : "2023-08-23T09:36:18.000",
"dims" :
{
"it" :
{
"pKey" : "338159",
"dimS" :
{
"mnk" : "HBBODBAFBDNAGOAEMMDKMLHCADEHCLGEKJHCKBIALPJCLPHF!M!S!SOMJIMIAFBDNAGOAEEGJKDPPLPDBDLAJEFLMFLGHLADJGIHMM"
}
}
}
}
}
}
}
public static BpmProcessInfoResult GetBpmWorkspace(string moniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetBpmWorkspace()
{
// Create object moniker
tBpmProcess = new BpmProcessId() { id = moniker }
};
// Get information about workspace contents
var result = somClient.GetBpmWorkspace(tGet);
return result;
}

See also:

Working with Processes