closeWorkItem

Use this operation to close a work item. This operation is for work items that are not completed, but on which work has been paused.

The work item must be in an Opened state to close it.

Note that this operation is available in two different services:

  • WorkPresentationService - The closeWorkItem operation in this service should be used to close a form that was opened when the work item was opened with the openWorkItem operation. This is typically called in response to a user clicking the Close button on a work item form.
  • WorkItemManagementService - The closeWorkItem operation in this service is used only if the user task did not open a form when the work item was opened. This would be used only in special use-case client applications.
This operation sets the state to one of the following:
  • PendHidden - The work item is set to this state only if the closeWorkItem operation is called using the SOAP API from the WorkItemManagementService, and a hidden period is specified in the hiddenPeriod parameter.
  • Offered - The work item is set to this state only if the work item had a state of Offered when it was opened, and the Distribution Strategy was set to "Re-offer On Close" when the user task was defined in TIBCO Business Studio.
  • Pended - The work item is set to this state if neither of the conditions described above apply.