element previewWorkItemRequest
diagram wp_diagrams/wp_p257.png
namespace http://api.wp.n2.tibco.com
properties
content complex
children payloadMode previewWorkItemFromList channelId channelType
annotation
documentation
Request element for previewing a workItem
source <xs:element name="previewWorkItemRequest">
 
<xs:annotation>
   
<xs:documentation>Request element for previewing a workItem</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="payloadMode" type="df:payloadModeType" default="JSON">
       
<xs:annotation>
         
<xs:documentation>Enumerated value defining the format of the data payload to be used in the response message (XML or JSON). If none is specified , it defaults to JSON

If not specified, the default value is JSON.

(RSS is currently not supported.)
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="previewWorkItemFromList">
       
<xs:annotation>
         
<xs:documentation>Request element for previewWorkItemFromList operation.</xs:documentation>
       
</xs:annotation>
       
<xs:complexType>
         
<xs:sequence>
           
<xs:element name="entityID" type="orgdto:XmlModelEntityId">
             
<xs:annotation>
               
<xs:documentation>ID of the organization model entity for whom work items are to be previewed.</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="workItemID" type="brm:ObjectID" maxOccurs="unbounded">
             
<xs:annotation>
               
<xs:documentation>ID of a work item to be previewed.</xs:documentation>
             
</xs:annotation>
           
</xs:element>
           
<xs:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded">
             
<xs:annotation>
               
<xs:documentation>Fieldname to be included in the returned data. This defines the set of fields for which preview data is to be to be returned:

- If any fieldnames are specified, only those fields will be returned for each work item.

- If no fieldnames are specified, all fields will be returned for each work item.
</xs:documentation>
             
</xs:annotation>
           
</xs:element>
         
</xs:sequence>
       
</xs:complexType>
     
</xs:element>
     
<xs:element name="channelId" type="xs:string">
       
<xs:annotation>
         
<xs:documentation>Identifier of the channel to which the requesting client application is bound.

See "Identifying the Client Channel in a Service Call" in the BPM Developer Guide for more information.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="channelType" type="ct:ChannelType">
       
<xs:annotation>
         
<xs:documentation>Enumerated value defining the channel type (technology) associated with the specified channelId. One of:

- openspaceChannel
- MobileChannel
- GIChannel
- EmailChannel

See "Identifying the Client Channel in a Service Call" in the BPM Developer Guide for more information.

Note: JSPChannel, PageflowChannel and RssChannel are currently not supported.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

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