openWorkItem

Use this operation to open a work item and to retrieve the associated data. The work item must be Allocated or Pended, and its state is changed to Opened. The operation returns the body of the work item.

Note that this operation is available in three different services:

  • WorkPresentationService - The openWorkItem operation in this service can be used in the following situations:
    • If the user task is designed to display a form. This is typical for most client applications. (If the work item is designed to display a custom form, rather than a TIBCO Business Studio form, also see Using Custom Forms.)
    • If the user task is designed to start a pageflow. The response from the openWorkItem request contains the pageflow details, which you use with the startPageFlow operation in the PageFlowService to start the pageflow.
  • ClientService - The openWorkItem operation in this service can be used as an alternative to using the openWorkItem operation in the WorkPresentationService when the work item starts a pageflow (see above). The openWorkItem operation in the ClientService does not require that you explicitly start the pageflow. The ClientService retrieves the appropriate form for the page activity, and ensures that the work item is completed when the pageflow is completed.
  • WorkItemManagementService - The openWorkItem operation is this service is used only if the user task does not open a form nor start a pageflow. This would be used only in special use-case client applications.