SOAP API - openNextWorkItem

The table summarizes the SOAP API - openNextWorkItem.

Request Uses the baseRequest element (from the WorkPresentationService schema)
Parameter notes
  • resourceId: The GUID of the resource for whom the next work item from the work queue is to be opened.
  • channelID: ID of the channel to use. If it is omitted, the default channel for the specified channelType is used.
  • responsePayloadMode: mode in which the response payload must be returned. The payload mode can be either XML or JSON.
  • workListViewID (Optional): the ID of the work list view associated with this work item. This is used to determine the work item to open next. To use the default work view, use -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:baseRequest action="OPEN_NEXT">
         <resourceId>tibco-admin</resourceId>
         <channelId>openspaceGWTPull_DefaultChannel</channelId>
         <channelType>openspaceChannel</channelType>
         <responsePayloadMode>XML</responsePayloadMode>
         <workListViewId>-1</workListViewId>
      </api:baseRequest>
   </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="XML" xmlns="">
            <XmlPayload>
               <inputs array="false" name="Message" type="String">
                  <simpleSpec>
                     <value>Please call John at 3.45.</value>
                  </simpleSpec>
               </inputs>
            </XmlPayload>
         </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="6" version="1" xmlns=""/>
      </workResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>