SOAP API - cancelWorkItem

The table summarizes the SOAP API - cancelWorkItem.

Request Uses the baseWorkRequest 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.
  • workItemId: ID of the work item being cancelled.
  • 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.
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="1">?</workItem>
         <workTypeDetail uid="WT__81TKQFlFEd-5Ae672m_IWw" version="1" openNextPiled="true"/>
         <payloadDetails payloadMode="XML">
            <XmlPayload>
            </XmlPayload>
         </payloadDetails>
      </api:workRequest>
   </soapenv:Body>
Response: 
<SOAP-ENV:Body>
      <workResponse isSuccessful="true" xmlns="http://api.wp.n2.tibco.com"/>
   </SOAP-ENV:Body>