SOAP API - updatePageFlow

The table summarizes the SOAP API - updatePageFlow.

Request Uses the updatePageFlow element (from the PageFlowService schema).
Parameter notes
  • context.processReference.id and context.activityReference.activityId can be obtained from the previous startPageFlow or updatePageFlow response.
  • pageFields should contain the data to be updated, as returned by the form.

    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.

See Displaying a Form in a Pageflow for more information.

Response Returns an updatePageFlowResponse element (from the PageFlowService schema).
Example Request: 
<soapenv:Body>
      <pag:updatePageFlow>
         <context>
            <processReference>
               <id>pvm:0a10q</id>
            </processReference>
            <activityReference activityId="pvm:001gq.5"/>
         </context>
         <pageFields feedFormat="NO_FORMAT" feedMode="XML">
            <XMLObjectModel>
               <inputs array="false" name="Names" optional="true" type="Complex">
                  <simpleSpec/>
               </inputs>
            </XMLObjectModel>
         </pageFields>
         <responseFeedType>
            <feedTypes feedFormat="NO_FORMAT" feedMode="XML"/>
         </responseFeedType>
      </pag:updatePageFlow>
   </soapenv:Body>
Response: 
<SOAP-ENV:Body>
      <updatePageFlowResponse xmlns="http://pageflow.api.pfe.n2.tibco.com">
         <pageResponse executionState="COMPLETED" xmlns="">
            <context>
               <pageFlowTemplate hasFormalParameters="false" moduleName="/Inject/Process Packages_Inject/ProcessPackage.xpdl" processName="ProcessPackageProcess" version="1.0.0.201108021509"/>
               <processReference>
                  <id>pvm:0a10q</id>
                  <name>ProcessPackageProcess</name>
               </processReference>
            </context>
            <pageData>
               <responseFeed>
                  <XMLObjectModel xmlns:pag="http://pageflow.api.pfe.n2.tibco.com" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
                     <inputs array="false" name="Names" optional="true" type="Complex">
                        <simpleSpec/>
                     </inputs>
                  </XMLObjectModel>
               </responseFeed>
            </pageData>
         </pageResponse>
      </updatePageFlowResponse>
   </SOAP-ENV:Body>