Class: CloseWorkItemPresentationRequest

tibco.objectapi.service.request.CloseWorkItemPresentationRequest

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

Object CloseWorkItemPresentationRequest Usage: RestApiService.getWorkPresentationService().closeWorkItem(request, callback);
Parameters:
Name Type Description
payload tibco.objectapi.common.datafeed.DataPayload The payload for the work item being closed.
id number (Java type: long) ID of the work item to be closed.
userId string GUID of the resource that wants to close the work item.
typeUid string 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) 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) 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 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