SOAP API - updateBusinessService

The table summarizes the SOAP API - updateBusinessService.

Request Uses the updateBusinessService element (from the BusinessService schema)
Parameter notes
  • process reference id: ID returned when you start a business service. You can obtain the value from the response returned by startBusinessService.
  • activityId: the activity ID returned when you start a business service. You can obtain the value from the response returned by startBusinessService.
  • 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.
  • If your process has mandatory parameters, ensure that you provide valid values for all these parameters.
Response Returns an updateBusinessServiceResponse element (from the BusinessService schema)
Example Request: 
<soapenv:Body>
      <bus:updateBusinessService>
         <context>
            <processReference>
               <id>pvm:0a101s</id>
            </processReference>
            <activityReference activityId="pvm:001g1s.3"/>
         </context>
         <pageFields payloadMode="XML">
            <XmlPayload>
                     <inouts array="false" name="UserName" optional="true" type="String">
                        <simpleSpec>
			   <value>TIB_USER</value>
			</simpleSpec>
                     </inouts>
                     <inouts array="false" name="PhoneNumber" optional="true" type="String">
                         <simpleSpec>
			   <value>987654321</value>
			</simpleSpec>
                     </inouts>
                  </XmlPayload>
         </pageFields>
         <responsePayloadMode>XML</responsePayloadMode>
      </bus:updateBusinessService>
   </soapenv:Body>
  Response: 
<SOAP-ENV:Body>
      <updateBusinessServiceResponse xmlns="http://business.api.busserv.n2.tibco.com">
         <pageResponse executionState="COMPLETED" xmlns="">
            <context>
               <pageFlowTemplate hasFormalParameters="false" moduleName="/PageflowSolution/Process Packages/ProcessPackage.xpdl" processName="RequestCall" version="1.0.0.201108111516"/>
               <processReference>
                  <id>pvm:0a101s</id>
                  <name>RequestCall</name>
               </processReference>
            </context>
            <pageData>
               <payload payloadMode="XML">
                  <XmlPayload xmlns:bus="http://business.api.busserv.n2.tibco.com" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
                     <inouts array="false" name="UserName" optional="true" type="String">
                        <simpleSpec>
                           <value>TIB_USER</value>
                        </simpleSpec>
                     </inouts>
                     <inouts array="false" name="PhoneNumber" optional="true" type="String">
                        <simpleSpec>
                           <value>987654321</value>
                        </simpleSpec>
                     </inouts>
                  </XmlPayload>
               </payload>
            </pageData>
         </pageResponse>
      </updateBusinessServiceResponse>
   </SOAP-ENV:Body>