Class: CompleteWorkItemClientRequest

tibco.objectapi.service.request.CompleteWorkItemClientRequest

new CompleteWorkItemClientRequest(payload, id, userId, typeUid, typeVersion)

Object CompleteWorkItemClientRequest Usage: RestApiService.getClientService().completeWorkItem(request, callback);
Parameters:
Name Type Description
payload tibco.objectapi.common.datafeed.DataPayload Defines the payload for the work item being completed.
id number (Java type: long) ID of the work item to be completed.
userId string GUID of the resource that wants to complete the work item.
typeUid string Unique ID of the work type from which the work item is derived.
typeVersion string Version number of the work type from which the work item is derived.
Since:
  • 4.0.0

Members

channelId :string

Query parameter: 'channelid' (optional, default=openspaceGWTPull_DefaultChannel) Identifier of the channel to which the requesting client application is bound.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = openspaceGWTPull_DefaultChannel

channelType :string

Query parameter: 'channeltype' (optional, default=openspaceChannel) 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

piled :boolean

Query parameter: 'ispiled' (optional, default=false) If work items are piled, a value of true causes the next work item to automatically open. For information on piled work items, see the TIBCO Business Studio Process Modeling User's Guide.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = false

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 opened. If set to -1 or omitted, the latest version of the work item is used.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = -1