closeWorkItem

Closes a work item (and updates the associated input and output data).

Note: There is a closeWorkItem operation in two services:
  • WorkItemManagementService (the one described here) - Use this one 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 that the closeWorkItem operation in this service does not allow you to pass a payload when closing the work item (which you can do in the SOAP API). To pass a payload when using the REST API, you can call saveOpenWorkItem first, then close the work item with the closeWorkItem operation (this causes the work item version to be incremented by 2).

  • WorkPresentationService - Use this one 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.
  • The request must specify the work item that should be closed.
  • The response returns the ID of the closed work item.
  • This operation sets the state to either PendHidden, Offered, or Pended -- for information, see closeWorkItem.
  • This operation can only be used if the work item is in a state from which it can be closed. See Work Item State Transitions.
  • This operation can only be used if the work item is assigned to the user with whose credentials the operation is being invoked.
Required System Action
Requires closeOtherResourcesItems in order to close a work item currently allocated to another user—for example, when a manager is closing an item in a supervised work list (see Creating and Managing Supervised Work List Views for information on supervised work lists).

Otherwise, none.

API Descriptions