complexType BaseRequest

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

element BaseRequest/resourceId

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

element BaseRequest/channelId

diagram |
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 | <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>

element BaseRequest/channelType

diagram |
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 | <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>

element BaseRequest/responsePayloadMode

diagram |
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 | <xs:element name="responsePayloadMode" type="df:payloadModeType" default="JSON" 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 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>

element BaseRequest/workListViewId

diagram |
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 | <xs:element name="workListViewId" type="xs:long" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The ID of the work list view associated with this work item, used when calling Open Next to determine which item to retrieve</xs:documentation> </xs:annotation> </xs:element>

element BaseRequest/getGlobalValues

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

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