SOAP API - saveOpenWorkItem

The table summarizes the SOAP API - saveOpenWorkItem.

Request Uses the saveOpenWorkItem element (from the WorkItemManagementService schema)
Parameter notes
  • workItemID: ID of the work item for which information is required.
  • version: (Optional) If omitted, the latest version is used.
  • workItemPayload: the complete body of the work item. This contains the data to be saved.

    Can be obtained from the response to openWorkItem.

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

Response Returns a saveOpenWorkItemResponse 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:saveOpenWorkItem>
         <workItemID id="4" version="9"/>
         <workItemPayload>
            <dataModel>
               <inputs array="false" name="ContactPhone" type="String">
                  <simpleSpec>
                     <value>778-677-7888</value>
                  </simpleSpec>
               </inputs>
               <inputs array="false" name="Message" type="String">
                  <simpleSpec>
                     <value>Wants to buy a model ZZ-900.</value>
                  </simpleSpec>
               </inputs>
               <inputs array="false" name="ContactName" type="String">
                  <simpleSpec>
                     <value>Frank Johnson</value>
                  </simpleSpec>
               </inputs>
               <inouts array="false" name="Notes" type="String">
                  <simpleSpec>
                     <value>Is not interested in the Classic model.</value>
                  </simpleSpec>
               </inouts>
            </dataModel>
         </workItemPayload>
      </api:saveOpenWorkItem>
   </soapenv:Body>
</soapenv:Envelope>
  Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <saveOpenWorkItemResponse xmlns="http://api.brm.n2.tibco.com">
         <workItemID id="4" version="10" xmlns=""/>
      </saveOpenWorkItemResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>