SOAP API - injectBusinessServiceEvent

The table summarizes the SOAP API - injectBusinessServiceEvent.

Request Uses the injectBusinessServiceEvent element (from the BusinessService schema)
Parameter notes
  • eventDefinition: It consists of the moduleName, processName, eventName, and processInstanceId of the specified business service. You can obtain the values for these parameters from the response returned by startBusinessService or updateBusinessService operations.
  • formalParams: values for the formal parameters that you want to inject. You must obtain this information directly from the relevant project in TIBCO Business Studio.

    Also, 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.

Response Returns an injectBusinessServiceEventResponse element (from the BusinessService schema)
Example Request: 
<soapenv:Body>
      <bus:injectBusinessServiceEvent>
	 <eventDefinition moduleName="/EventHandler/Process Packages/EventHandler.xpdl" processName="EventHandlerProcess" eventName="IntermediateEvent" processInstanceId="pvm:0a10a"/>
<formalParams payloadMode="XML">
<XmlPayload>
<inputs array="false" name="Parameter" optional="false" type="String">
		<simpleSpec length="50">
<value>Tibco</value>
</simpleSpec>
</inputs>
	 <inputs array="false" name="Parameter2" optional="false" type="Integer Number">
		<simpleSpec length="9">
<value>147</value>
</simpleSpec>
</inputs>
		<inputs array="false" name="Parameter3" optional="false" type="Decimal Number">
	<simpleSpec decimal="2" length="10">
			 <value>3.14</value>
		</simpleSpec>
		</inputs>
		<inputs array="false" name="Parameter4" optional="false" type="Boolean">
		<simpleSpec>
			 <value>false</value>
			</simpleSpec>
		</inputs>
		<inputs array="false" name="Parameter5" optional="false" type="Date">
	<simpleSpec>
			 <value>2012-02-29</value>
		</simpleSpec>
		</inputs>
		<inputs array="false" name="Parameter6" optional="false" type="Time">
	<simpleSpec>
		<value>09:30:10.5</value>
		</simpleSpec>
		</inputs>
<inputs array="false" name="Parameter7" optional="false" type="Date Time">
	<simpleSpec>
			 <value>2009-04-06%2002-05-30T09:30:10Z</value>
		</simpleSpec>
		</inputs>
</XmlPayload>
</formalParams>
<responsePayloadMode>XML</responsePayloadMode>
</bus:injectBusinessServiceEvent>
</soapenv:Body>
  Response: 
<SOAP-ENV:Body>
      <injectBusinessServiceEventResponse xmlns="http://business.api.busserv.n2.tibco.com">
         <pageResponse executionState="IN_PROGRESS" xmlns="">
            <context>
               <pageFlowTemplate hasFormalParameters="false" moduleName="/EventHandler/Process Packages/EventHandler.xpdl" processName="EventHandlerProcess" version="1.0.0.201108111140"/>
               <processReference>
                  <id>pvm:0a10a</id>
                  <name>EventHandlerProcess</name>
               </processReference>
            </context>
<pageData>
               <pageReference activityId="pvm:001ga.f" activityModelId="_tM7ysL0REeCCNPLAO2IuzQ" activityName="UserTask3" moduleName="/EventHandler/Process Packages/EventHandler.xpdl" moduleVersion="1.0.0.201108111140" processName="EventHandlerProcess"/>
               <payload payloadMode="XML">
                  <XmlPayload>
                     <inputs array="false" name="Parameter" optional="true" type="String">
                        <simpleSpec>
                           <value>[Ljava.lang.String;@6092c80d</value>
                        </simpleSpec>
                     </inputs>
                     <inputs array="false" name="Parameter2" optional="true" type="Integer Number">
                        <simpleSpec>
                           <value>[Ljava.lang.String;@740ee811</value>
                        </simpleSpec>
                     </inputs>
<inputs array="false" name="Parameter3" optional="true" type="Decimal Number">
                        <simpleSpec>
                           <value>[Ljava.lang.String;@7ea5ef9d</value>
                        </simpleSpec>
                     </inputs>
<inputs array="false" name="Parameter4" optional="true" type="Boolean">
                        <simpleSpec>
                           <value>[Ljava.lang.String;@40166d60</value>
                        </simpleSpec>
                     </inputs>
                     <inputs array="false" name="Parameter5" optional="true" type="Date">
                        <simpleSpec>
                           <value>[Ljava.lang.String;@66da7f</value>
                        </simpleSpec>
                     </inputs>
<!-- Response continued -->
  
<!-- Continued -->
<inputs array="false" name="Parameter6" optional="true" type="Time">
                        <simpleSpec>
                           <value>[Ljava.lang.String;@448bff03</value>
                        </simpleSpec>
                     </inputs>
                     <inputs array="false" name="Parameter7" optional="true" type="Date Time">
                        <simpleSpec>
                           <value>[Ljava.lang.String;@4313411d</value>
                        </simpleSpec>
                     </inputs>
                  </XmlPayload>
               </payload>
            </pageData>
         </pageResponse>
      </injectBusinessServiceEventResponse>
   </SOAP-ENV:Body>