SOAP API - completeWorkItem

The table summarizes the SOAP API - completeWorkItem.

Request Uses the workRequest element (from the WorkPresentationService schema)
Parameter notes
  • channelID: ID of the channel to use. If it is omitted, the default channel for the specified channelType is used.
  • openNextPiled: An optional Boolean field. If work items are piled, a value of true will automatically open the next work item. For information on piled work items, see the TIBCO Business Studio Process Modeling User's Guide.
  • payloadDetails: See Valid Format for DataModel for information about the valid format.
Response Returns a workResponse element (from the WorkPresentationService schema)
Example Request: 
<soapenv:Body>
      <api:workRequest action="?">
         <resourceId>2D6430DC-9A65-4F21-A3BE-798AA192E468</resourceId>
         <channelId>?</channelId>
         <channelType>openspaceChannel</channelType>
         <responsePayloadMode>XML</responsePayloadMode>
         <workItem id="37" version="3"/>
         <workTypeDetail uid="WT__81TKQFlFEd-5Ae672m_IWw" version="1.0.0.201108111516" openNextPiled="true"/>
         <payloadDetails payloadMode="XML">
            <XmlPayload>
               <inputs array="false" name="Message" type="String">
                  <simpleSpec>
                     <value>Please call TIB_USER at 987654321.</value>
                  </simpleSpec>
               </inputs>
            </XmlPayload>
         </payloadDetails>
      </api:workRequest>
   </soapenv:Body>
Response: 
<SOAP-ENV:Body>
      <workResponse isSuccessful="true" xmlns="http://api.wp.n2.tibco.com"/>
   </SOAP-ENV:Body>