Class: CancelWorkItemRequest

tibco.objectapi.service.request.CancelWorkItemRequest

new CancelWorkItemRequest(id, userId)

Object CancelWorkItemRequest Usage: RestApiService.getWorkPresentationService().cancelWorkItem(request, callback);
Parameters:
Name Type Description
id number (Java type: long) ID of the work item being cancelled.
userId string ID of the user cancelling the work item.
Since:
  • 4.0.0

Members

channelId :string

Query parameter: 'channelid' (optional) ID of the channel to use.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = openspaceGWTPull_DefaultChannel

channelType :string

Query parameter: 'channeltype' (optional) Enumerated value defining the channel type (technology) associated with the specified channelId. The valid entries are:
  • openspaceChannel
  • MobileChannel
  • GIChannel
  • EmailChannel

For more information, see "Identifying the Client Channel in a Service Call" in the developer guide.

Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = openspaceChannel

responseType :string

Query parameter: 'responsetype' (optional) Enumerated value defining the format of the data payload to be used in the response message - either XML or JSON.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = JSON

version :number

Query parameter: 'version' (Java type: long) (optional) Version number of the work item to be cancelled. If set to -1 or omitted, the latest version of the work item is used.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = -1