SOAP API - completeWorkItem

The table summarizes the SOAP API - completeWorkItem.

Request Uses the completeWorkItem element (from the WorkItemManagementService schema)
Parameter notes
  • workItemID: ID of the work item to be completed.
  • version: (Optional) If it is omitted, the latest version is used.
  • workItemPayload: the complete body of the work item: data to be written to the work item as part of the Complete action.

    See Valid Format for DataModel for information about the valid format.

  • getNextPiledItem: (Optional Boolean) If work items are piled, passing true causes this method to retrieve the ManagedObjectId for the next work item. You must then call allocateAndOpenWorkItem to open the work item. For information about piled work items, see the TIBCO Business Studio Process Modeling User's Guide.
Response Returns a completeWorkItemResponse element (from the WorkItemManagementService schema)
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.brm.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:completeWorkItem>
         <workItemID id="66" version="2"/>
         <workItemPayload>
           <dataModel>
               <inputs array="false" name="IssueDescription" type="String">
                  <simpleSpec>
                     <value>Needs info</value>
                  </simpleSpec>
               </inputs>
               <inputs array="false" name="IssueDetails" type="String">
                  <simpleSpec>
                     <value>Model 888</value>
                  </simpleSpec>
               </inputs>
               <inputs array="false" name="ContactPhone" type="String">
                  <simpleSpec>
                     <value>993-334-3397</value>
                  </simpleSpec>
               </inputs>
               <inputs array="false" name="ContactName" type="String">
                  <simpleSpec>
                     <value>Ben Greer</value>
                  </simpleSpec>
               </inputs>
               <inouts array="false" name="ResolutionDescription" type="String">
                  <simpleSpec/>
               </inouts>
               <inouts array="false" name="ResolutionDetails" type="String">
                  <simpleSpec/>
               </inouts>
            </dataModel>
         </workItemPayload>
         <getNextPiledItem>true</getNextPiledItem>
      </api:completeWorkItem>
   </soapenv:Body>
</soapenv:Envelope>
  Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <completeWorkItemResponse xmlns="http://api.brm.n2.tibco.com">
         <nextWorkItem id="60" version="4" xmlns=""/>
      </completeWorkItemResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>