SOAP API - createProcessInstance

The table summarizes the SOAP API - createProcessInstance.

Request Uses the createProcessInstanceInput element (from the ProcessManagement schema)
Parameter notes
  • processQName: Can be obtained from listProcessTemplates , queryProcessTemplates, and queryProcessTemplatesAlt.
  • operationName: This is the "starter operation" name, which must be a start event with a trigger type of "None". Can be obtained from listStarterOperations.
  • parameterMap: The names of the "start parameters" (also known as "formal parameters") can be obtained from getStarterOperationInfo. In the case of a business object model, you must export the business object model to an XML schema definition (see Business Object Models) and then wrap the XML in a CDATA section (as shown in the example below). These are used to pass data into the process instance being started.
  • priority: (Optional) Priority value used to schedule the execution of this process instance.
Response Returns a processID element (from the ProcessManagement schema)
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType">
  <soapenv:Header/>
    <soapenv:Body>
      <proc:createProcessInstanceInput>
         <proc:processQName>
            <proc:moduleName>/OMSUBAPPB/Process Packages/OMSUBAPPB.xpdl</proc:moduleName>
            <proc:processName>OMSUBAPPBProcess</proc:processName>
            <proc:version>1.0.3</proc:version>
         </proc:processQName>
         <proc:operationName>StartEvent</proc:operationName>
         <proc:options>
            <proc:priority>100</proc:priority>
         </proc:options>
         <proc:parameterMap>
            <proc:parameter>
              <proc:name>myControlData</proc:name>
              <proc:value><![CDATA[
              <tns1:ControlDataElement xmlns:tns1="http://example.com/omsubbomappa" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://example.com/omsubbomappa com.example.omsubbomappa.xsd">
              <addressee>a</addressee>
              <email>a</email>
              <cdUt>false</cdUt>
              <cdEmail>false</cdEmail>
              <cdDB>true</cdDB>
              <cdWS>true</cdWS>
              <cdReceive>true</cdReceive>
              </tns1:ControlDataElement>
              ]]>
              </proc:value>
              <proc:name>myBusinessData</proc:name>
              <proc:value><![CDATA[
              <tns1:BusinessDataElement xmlns:tns1="http://example.com/omsubbomappa" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://example.com/omsubbomappa com.example.omsubbomappa.xsd">
              <correlateMe>a</correlateMe>
              <uniqueID>a</uniqueID>
              </tns1:BusinessDataElement>
              ]]>
              </proc:value>
            </proc:parameter>
         </proc:parameterMap>
    </proc:createProcessInstanceInput>
  </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <proc:processID xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType">pvm:0a1213</proc:processID>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>