SOAP API - openWorkItem

The table summarizes the SOAP API - openWorkItem.

Request Uses the baseWorkRequest element (from the WorkPresentationService schema)
Parameter notes
  • resourceId: The GUID of the resource for whom the work item is to be opened.
  • channelID: ID of the channel to use. If it is omitted, the default channel for the specified channelType is used.
  • workItemID: ID of the work item for which information to be opened.
  • version: (Optional). If it is omitted, the latest version is used.
  • openNextPiled: This parameter is not applicable to openWorkItem, cancelWorkItem , or closeWorkItem. The boolean value specified is used only when calling completeWorkItem.
  • workListViewID (Optional): the unique ID of the work view. It is not necessary to enter a value in this field as the default work list view is automatically used. To use the default work view, use 0 or -1.
Response Returns a workResponse element (from the WorkPresentationService schema)
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.wp.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:baseWorkRequest>
         <resourceId>tibco-admin</resourceId>
         <channelId>openspaceGWTPull_DefaultChannel</channelId>
         <channelType>openspaceChannel</channelType>
         <responsePayloadMode>JSON</responsePayloadMode>
         <workListViewId>-1</workListViewId>
         <workItem id="7" version="-1"</workItem>
         <workTypeDetail uid="WT__UXUNYCIYEeCnP8eZZTCDGg" version="1.0.0.201212131425" openNextPiled="true"/>
      </api:baseWorkRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <workResponse xmlns="http://api.wp.n2.tibco.com">
         <payloadModel payloadMode="JSON" xmlns="">
            <serializedPayload>{items:[{"$param":"Message","$value":["Please call John Smith at 07978324455."],"type":"String","mode":"IN"}]}</serializedPayload>
         </payloadModel>
         <workTypeDetail pilingLimit="0" typePiled="false" uid="WT__UXUNYCIYEeCnP8eZZTCDGg" version="1.0.0.201212131425" xmlns=""/>
         <presentation activityName="DisplayMessage" formIdenitifier="1.0.0.201212131425/openspaceGWTPull_DefaultChannel/.default/ProcessPackage/WelcomeUsers/DisplayMessage/DisplayMessage.gwt.json" type="GWT_FORM" version="1.0.0.201212131425" xmlns=""/>
         <workItem id="7" version="1" xmlns=""/>
      </workResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>