complexType BaseRequest
diagram wp_diagrams/wp_p2874.png
namespace http://base.api.wp.n2.tibco.com
children resourceId channelId channelType responsePayloadMode workListViewId getGlobalValues
attributes
Name  Type  Use  Default  Fixed  Annotation
action  ActionType        
documentation
** PRIVATE API - Reserved for internal use**

Defines the action for this request. (This is only required when calling WP Extender Servlet Chaning mechanism.)
annotation
documentation
Base request to retrieve details of a work item.
source <xsd:complexType name="BaseRequest">
 
<xsd:annotation>
   
<xsd:documentation>Base request to retrieve details of a work item.</xsd:documentation>
 
</xsd:annotation>
 
<xsd:sequence>
   
<xsd:element name="resourceId" type="xs:string">
     
<xsd:annotation>
       
<xsd:documentation>ID of the resource that wants to perform an operation on the work item.</xsd:documentation>
     
</xsd:annotation>
   
</xsd:element>
   
<xsd:element name="channelId" type="xs:string">
     
<xsd:annotation>
       
<xsd: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.
</xsd:documentation>
     
</xsd:annotation>
   
</xsd:element>
   
<xsd:element name="channelType" type="ct:ChannelType">
     
<xsd:annotation>
       
<xsd: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.
</xsd:documentation>
     
</xsd:annotation>
   
</xsd:element>
   
<xsd:element name="responsePayloadMode" type="df:payloadModeType" default="JSON" minOccurs="0">
     
<xsd:annotation>
       
<xsd: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.)
</xsd:documentation>
     
</xsd:annotation>
   
</xsd:element>
   
<xsd:element name="workListViewId" type="xs:long" minOccurs="0" maxOccurs="1">
     
<xsd:annotation>
       
<xsd:documentation>The ID of the work list view associated with this work item, used when calling Open Next to determine which item to retrieve</xsd:documentation>
     
</xsd:annotation>
   
</xsd:element>
   
<xsd:element name="getGlobalValues" type="xs:boolean" minOccurs="0">
     
<xsd:annotation>
       
<xsd:documentation>If you require the values or just the goref itsself.</xsd:documentation>
     
</xsd:annotation>
   
</xsd:element>
 
</xsd:sequence>
 
<xsd:attribute name="action" type="ActionType">
   
<xsd:annotation>
     
<xsd:documentation>** PRIVATE API - Reserved for internal use**

Defines the action for this request. (This is only required when calling WP Extender Servlet Chaning mechanism.)
</xsd:documentation>
   
</xsd:annotation>
 
</xsd:attribute>
</xsd:complexType>

attribute BaseRequest/@action
type ActionType
facets
Kind Value Annotation
enumeration OPEN_NEXT
enumeration INITIATE
enumeration OPEN
enumeration COMPLETE
enumeration CANCEL
enumeration CLOSE
annotation
documentation
** PRIVATE API - Reserved for internal use**

Defines the action for this request. (This is only required when calling WP Extender Servlet Chaning mechanism.)
source <xsd:attribute name="action" type="ActionType">
 
<xsd:annotation>
   
<xsd:documentation>** PRIVATE API - Reserved for internal use**

Defines the action for this request. (This is only required when calling WP Extender Servlet Chaning mechanism.)
</xsd:documentation>
 
</xsd:annotation>
</xsd:attribute>

element BaseRequest/resourceId
diagram wp_diagrams/wp_p2875.png
type xs:string
properties
content simple
annotation
documentation
ID of the resource that wants to perform an operation on the work item.
source <xsd:element name="resourceId" type="xs:string">
 
<xsd:annotation>
   
<xsd:documentation>ID of the resource that wants to perform an operation on the work item.</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element BaseRequest/channelId
diagram wp_diagrams/wp_p2876.png
type xs:string
properties
content simple
annotation
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.
source <xsd:element name="channelId" type="xs:string">
 
<xsd:annotation>
   
<xsd: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.
</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element BaseRequest/channelType
diagram wp_diagrams/wp_p2877.png
type ChannelType
properties
content simple
facets
Kind Value Annotation
enumeration JSPChannel
enumeration GIChannel
enumeration PageflowChannel
enumeration EmailChannel
enumeration RssChannel
enumeration openspaceChannel
enumeration MobileChannel
annotation
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.
source <xsd:element name="channelType" type="ct:ChannelType">
 
<xsd:annotation>
   
<xsd: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.
</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element BaseRequest/responsePayloadMode
diagram wp_diagrams/wp_p2878.png
type payloadModeType
properties
minOcc 0
maxOcc 1
content simple
default JSON
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 none is specified , it defaults to JSON

If not specified, the default value is JSON.

(RSS is currently not supported.)
source <xsd:element name="responsePayloadMode" type="df:payloadModeType" default="JSON" minOccurs="0">
 
<xsd:annotation>
   
<xsd: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.)
</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element BaseRequest/workListViewId
diagram wp_diagrams/wp_p2879.png
type xs:long
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
The ID of the work list view associated with this work item, used when calling Open Next to determine which item to retrieve
source <xsd:element name="workListViewId" type="xs:long" minOccurs="0" maxOccurs="1">
 
<xsd:annotation>
   
<xsd:documentation>The ID of the work list view associated with this work item, used when calling Open Next to determine which item to retrieve</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

element BaseRequest/getGlobalValues
diagram wp_diagrams/wp_p2880.png
type xs:boolean
properties
minOcc 0
maxOcc 1
content simple
annotation
documentation
If you require the values or just the goref itsself.
source <xsd:element name="getGlobalValues" type="xs:boolean" minOccurs="0">
 
<xsd:annotation>
   
<xsd:documentation>If you require the values or just the goref itsself.</xsd:documentation>
 
</xsd:annotation>
</xsd:element>

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