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.

    If complexSpec business data is passed into this operation, see Valid Format for ComplexSpec Business Data for information about the valid format.

  • getNextPiledItem: 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.
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="4" version="0"/>

         <workItemPayload>

            <dataModel>

               <!--Zero or more repetitions:-->

               <inputs name="PhoneNum" type="string" optional="?" array="false">

                  <!--You have a CHOICE of the next 2 items at this level-->

                  <!--Optional:-->

                  <simpleSpec length="?" decimal="?">

                     <!--Zero or more repetitions:-->

                     <value>555-14951</value>

                  </simpleSpec>

               </inputs>

               <inputs name="Name" type="string" optional="?" array="false">

                  <!--You have a CHOICE of the next 2 items at this level-->

                  <!--Optional:-->

                  <simpleSpec length="?" decimal="?">

                     <!--Zero or more repetitions:-->

                     <value>Francois Premier</value>

                  </simpleSpec>

		                  <!--Optional:-->

                  <complexSpec className="?">

                     <!--Zero or more repetitions:-->

                     <value>?</value>

                  </complexSpec>

               </inputs>

               <!--Zero or more repetitions:-->

               <outputs ........

               ........

               </outputs>

               <!--Zero or more repetitions:-->

               <inouts ........

               ........

               </inouts>

            </dataModel>

         </workItemPayload>

         <!--Optional:-->

         <getNextPiledItem>false</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"/>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>