new BaseRequest()
Base request to retrieve details of a work item.
Constructs a new BaseRequest.
The following features are supported:
Members
action :tibco.objectapi.wp.base.ActionType
** PRIVATE API - Reserved for internal use**
Defines the action for this request. (This is only required when calling WP Extender Servlet Chaning mechanism.)
This property holds the value of the 'Action' attribute.
Type:
channelId :string
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.
This property holds the value of the 'Channel Id' attribute.
Type:
- string
channelType :tibco.objectapi.common.channeltype.ChannelType
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.
This property holds the value of the 'Channel Type' attribute.
Type:
getGlobalValues :boolean
If you require the values or just the goref itsself.
This property holds the value of the 'Get Global Values' attribute.
Type:
- boolean
resourceId :string
ID of the resource that wants to perform an operation on the work item.
This property holds the value of the 'Resource Id' attribute.
Type:
- string
responsePayloadMode :tibco.objectapi.common.datafeed.PayloadModeType
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.)
This property holds the value of the 'Response Payload Mode' attribute.
Type:
workListViewId :string
The ID of the work list view associated with this work item, used when calling Open Next to determine which item to retrieve
This property holds the value of the 'Work List View Id' attribute.
Type:
- string