element injectBusinessServiceEvent

diagram |
namespace | http://business.api.busserv.n2.tibco.com
properties |
content | complex
children | eventDefinition formalParams responsePayloadMode
annotation |
documentation
Request element for injectBusinessServiceEvent operation.
source | <xs:element name="injectBusinessServiceEvent"> <xs:annotation> <xs:documentation>Request element for injectBusinessServiceEvent operation.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="eventDefinition" type="pfecom:EventDefinitionType"> <xs:annotation> <xs:documentation>Definition of the event to be injected and the business service instance into which it should be injected.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="formalParams" type="df:dataPayload" minOccurs="0"> <xs:annotation> <xs:documentation>Page data for the formal parameters associated with the eventDefinition.eventName event. Note: You cannot determine the names of these formal parameters programmatically. Instead, you must obtain them by examining the process in TIBCO Business Studio.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="responsePayloadMode" type="df:payloadModeType" minOccurs="0"> <xs:annotation> <xs:documentation>Enumerated value defining the format of the data payload to be used in the response message (XML or JSON). If not specified, the default value is JSON. (RSS is currently not supported.)</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element>

element injectBusinessServiceEvent/eventDefinition

diagram |
type | EventDefinitionType
properties |
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
moduleName | xs:string | required |  |  |
documentation
Module name that contains the pageflow process or business service.
processName | xs:string | required |  |  |
documentation
Name of the pageflow process or business service.
eventName | xs:string | required |  |  |
documentation
Name of the catch intermediate event in the pageflow process that handles the business event (for example, UpdateExchangeRates). Note: You cannot obtain this name programmatically. You must obtain it by examining the process in TIBCO Business Studio.
processInstanceId | xs:string | required |  |  |
documentation
Unique ID of the process instance into which the event should be injected.
annotation |
documentation
Definition of the event to be injected and the business service instance into which it should be injected.
source | <xs:element name="eventDefinition" type="pfecom:EventDefinitionType"> <xs:annotation> <xs:documentation>Definition of the event to be injected and the business service instance into which it should be injected.</xs:documentation> </xs:annotation> </xs:element>

element injectBusinessServiceEvent/formalParams

diagram |
type | dataPayload
properties |
minOcc | 0
maxOcc | 1
content | complex
children | serializedPayload XmlPayload
attributes |
Name | Type | Use | Default | Fixed | Annotation
payloadMode | payloadModeType |  | JSON |  |
documentation
Enumerated value defining the format of the data payload (JSON or XML). If not specified, the default value is JSON. (RSS is currently not supported.)
annotation |
documentation
Page data for the formal parameters associated with the eventDefinition.eventName event. Note: You cannot determine the names of these formal parameters programmatically. Instead, you must obtain them by examining the process in TIBCO Business Studio.
source | <xs:element name="formalParams" type="df:dataPayload" minOccurs="0"> <xs:annotation> <xs:documentation>Page data for the formal parameters associated with the eventDefinition.eventName event. Note: You cannot determine the names of these formal parameters programmatically. Instead, you must obtain them by examining the process in TIBCO Business Studio.</xs:documentation> </xs:annotation> </xs:element>

element injectBusinessServiceEvent/responsePayloadMode

diagram |
type | payloadModeType
properties |
minOcc | 0
maxOcc | 1
content | simple
facets |
Kind | Value | Annotation
enumeration | XML |
enumeration | JSON |
enumeration | RSS |
annotation |
documentation
Enumerated value defining the format of the data payload to be used in the response message (XML or JSON). If not specified, the default value is JSON. (RSS is currently not supported.)
source | <xs:element name="responsePayloadMode" type="df:payloadModeType" minOccurs="0"> <xs:annotation> <xs:documentation>Enumerated value defining the format of the data payload to be used in the response message (XML or JSON). If not specified, the default value is JSON. (RSS is currently not supported.)</xs:documentation> </xs:annotation> </xs:element>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy