closeWorkItem

Use this operation to close a work item and to update the associated data with any changes the user has made while it was open. This operation is for work items that are not completed, but on which work has been paused.

The work item must be Opened. The operation sets the state to either PendHidden, if a hiddenPeriod is specified as an input parameter for this operation, or to Pended.

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.

  For API reference information for the closeWorkItem operation in this service, see closeWorkItem.

• 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.
  Note: One special use-case for using the closeWorkItem operation in WorkItemManagementService is to set the work item state to PendHidden so that it does not appear in the work list for a specified period of time. For more information, see Accessing Hidden Work Items .

  For API reference information for the closeWorkItem operation in this service, see closeWorkItem.