element startPageFlow
diagram pfe-pageflow-service_diagrams/pfe-pageflow-service_p17.png
namespace http://pageflow.api.pfe.n2.tibco.com
properties
content complex
children pageFlowDefinition formalParams responsePayloadMode cacheTimeout
annotation
documentation
Request element for startPageFlow operation.
source <xs:element name="startPageFlow">
 
<xs:annotation>
   
<xs:documentation>Request element for startPageFlow operation.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="pageFlowDefinition" type="pfecom:PFETemplate">
       
<xs:annotation>
         
<xs:documentation>Unique identifier of the pageflow to be started.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="formalParams" type="df:dataPayload" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Data for the formal parameters associated with the pageflow start 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">
       
<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:element name="cacheTimeout" type="xs:long" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>**PRIVATE API - Reserved for internal use**

Timeout value (in minutes) for the pageflow activity.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element startPageFlow/pageFlowDefinition
diagram pfe-pageflow-service_diagrams/pfe-pageflow-service_p18.png
type PFETemplate
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.
version  xs:string  required      
documentation
Version of the process.
annotation
documentation
Unique identifier of the pageflow to be started.
source <xs:element name="pageFlowDefinition" type="pfecom:PFETemplate">
 
<xs:annotation>
   
<xs:documentation>Unique identifier of the pageflow to be started.</xs:documentation>
 
</xs:annotation>
</xs:element>

element startPageFlow/formalParams
diagram pfe-pageflow-service_diagrams/pfe-pageflow-service_p19.png
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
Data for the formal parameters associated with the pageflow start 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>Data for the formal parameters associated with the pageflow start 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 startPageFlow/responsePayloadMode
diagram pfe-pageflow-service_diagrams/pfe-pageflow-service_p20.png
type payloadModeType
properties
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">
 
<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>

element startPageFlow/cacheTimeout
diagram pfe-pageflow-service_diagrams/pfe-pageflow-service_p21.png
type xs:long
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
**PRIVATE API - Reserved for internal use**

Timeout value (in minutes) for the pageflow activity.
source <xs:element name="cacheTimeout" type="xs:long" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>**PRIVATE API - Reserved for internal use**

Timeout value (in minutes) for the pageflow activity.
</xs:documentation>
 
</xs:annotation>
</xs:element>


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