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 it is omitted, the latest version is used.
  • workItemPayload: the complete body of the work item. This contains the data to be saved.

    If complexSpec business data is passed into this operation, see Valid Format for ComplexSpec Business Data 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="54"/>

         <workItemPayload>

            <dataModel>

               <inputs name="Message" type="String" optional="?" array="false">

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

                     <value>Please call William Tanner at 555-1066.</value>

                  </simpleSpec>

                  <complexSpec className="?">

                     <value>?</value>

                  </complexSpec>

               </inputs>

               <outputs name="?" type="?" optional="?" array="?">

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

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

                     <value>?</value>

                  </simpleSpec>

                  <complexSpec className="?">

                     <value>?</value>

                  </complexSpec>

               </outputs>

               <inouts name="?" type="?" optional="?" array="?">

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

                     <value>?</value>

                  </simpleSpec>

                  <complexSpec className="?">

                     <value>?</value>

                  </complexSpec>

               </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="54" version="3" xmlns=""/>

      </saveOpenWorkItemResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>
Contents
Search Results