SOAP API - startPageFlow

The table summarizes the SOAP API - startPageFlow.

Request Uses the startPageFlow element (from the PageFlowService schema).
Parameter notes
  • pageFlowDefinition. The moduleName, processName and version attributes can be obtained by using listPageFlows .
  • formalParams: You cannot determine the names and details of formal parameters programmatically. Instead, you must obtain them by examining the process in TIBCO Business Studio.

    If the data payload contains ComplexSpec parameters, you can view their structure in TIBCO Business Studio. There is no API to determine the structure. To view the structure in TIBCO Business Studio, you must export the XML schema, which shows the structure to which the data must conform. For information, see Obtaining Information from TIBCO Business Studio.

  • responsePayloadMode: This element is optional for this operation. If omitted, it defaults to JSON.
Response Returns a startPageFlowResponse element (from the PageFlowService schema).
Example Request: 
<soapenv:Body>
      <pag:startPageFlow>
         <pageFlowDefinition moduleName="/Inject/Process Packages_Inject/ProcessPackage.xpdl" processName="ProcessPackageProcess" version="1.0.0.201108161050"/>
         <formalParams payloadMode="XML">
             <XmlPayload>
                  <inputs name="Names" type="Text" optional="true" array="false">
                  <simpleSpec length="50">
                     <value>TIBCO</value>
                  </simpleSpec>
		  </inputs>
            </XmlPayload>
         </formalParams>
         <responsePayloadMode>XML</responsePayloadMode>
      </pag:startPageFlow>
   </soapenv:Body>
  Response: 
<SOAP-ENV:Body>
      <startPageFlowResponse xmlns="http://pageflow.api.pfe.n2.tibco.com">
         <pageResponse executionState="IN_PROGRESS" xmlns="">
            <context>
               <pageFlowTemplate hasFormalParameters="false" moduleName="/Inject/Process Packages_Inject/ProcessPackage.xpdl" processName="ProcessPackageProcess" version="1.0.0.201108161050"/>
               <processReference>
                  <id>pvm:0a101f</id>
                  <name>ProcessPackageProcess</name>
               </processReference>
            </context>
            <pageData>
               <pageReference activityId="pvm:001g1f.5" activityModelId="_VK4SIKh8EeCt2PSB39ZXYA" activityName="UserTasks" moduleName="/Inject/Process Packages_Inject/ProcessPackage.xpdl" moduleVersion="1.0.0.201108161050" processName="ProcessPackageProcess"/>
               <payload payloadMode="XML">
                  <XmlPayload/>
               </payload>
            </pageData>
         </pageResponse>
      </startPageFlowResponse>
   </SOAP-ENV:Body>