openWorkItem

Opens a work item (to get the associated input and output data).

Note: There is an openWorkItem operation in three services:
  • WorkItemManagementService (the one described here) - Use this service if the user task was designed to not open a form nor start a pageflow. This would typically be used only in special use-case client applications.
  • WorkPresentationService - Use this service if the user task was designed to either open a form or start a pageflow, which is typical for most client applications (see openWorkItem ).
  • ClientService - Use the openWorkItem operation in this service as an alternative to the one in the WorkPresentationService when opening a work item that starts a pageflow. When using this service, you do not need to explicitly start the pageflow. This service handles retrieving the appropriate form for the page activity, and ensures that the work item is completed when the pageflow is completed. Note that this service is available in REST only.
  • The request must specify the work item that should be opened.
  • The response returns the work item body of the opened work item.
  • This operation can only be used if the work item is in a state from which it can be opened. 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.
Note: If you are opening work items that are chained, use the openWorkItem operation in WorkPresentationService instead of this one.
Required System Action
Requires openOtherResourcesItems in order to open a work item currently allocated to another user—for example, when a manager is opening 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