# Class: WorkRequest

## tibco.objectapi.wp.base.WorkRequest

#### new WorkRequest()

Base work request to retrieve details of a work item, supplying payload information. Constructs a new WorkRequest.

The following features are supported:

- `Payload Details`

### Extends

- tibco.objectapi.wp.base.BaseWorkRequest

### 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:

- tibco.objectapi.wp.base.ActionType

Inherited From:
  - tibco.objectapi.wp.base.BaseRequest#action

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

Inherited From:
  - tibco.objectapi.wp.base.BaseRequest#channelId

#### 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:

- tibco.objectapi.common.channeltype.ChannelType

Inherited From:
  - tibco.objectapi.wp.base.BaseRequest#channelType

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

Inherited From:
  - tibco.objectapi.wp.base.BaseRequest#getGlobalValues

#### payloadDetails :tibco.objectapi.common.datafeed.DataPayload

Data payload for the specified work item. This property holds the value of the 'Payload Details' containment reference.

##### Type:

- tibco.objectapi.common.datafeed.DataPayload

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

Inherited From:
  - tibco.objectapi.wp.base.BaseRequest#resourceId

#### 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:

- tibco.objectapi.common.datafeed.PayloadModeType

Inherited From:
  - tibco.objectapi.wp.base.BaseRequest#responsePayloadMode

#### workItem :tibco.objectapi.wp.base.WorkItem

Identifier of the work item on which the operation is to be performed. This property holds the value of the 'Work Item' containment reference.

##### Type:

- tibco.objectapi.wp.base.WorkItem

Inherited From:
  - tibco.objectapi.wp.base.BaseWorkRequest#workItem

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

Inherited From:
  - tibco.objectapi.wp.base.BaseRequest#workListViewId

#### workTypeDetail :tibco.objectapi.wp.base.WorkTypeDetailType

Details of the work type associated with the specified work item. Note: workTypeDetail information is not mandatory for openWorkItem or cancelWorkItem operations. This property holds the value of the 'Work Type Detail' containment reference.

##### Type:

- tibco.objectapi.wp.base.WorkTypeDetailType

Inherited From:
  - tibco.objectapi.wp.base.BaseWorkRequest#workTypeDetail