SOAP API - openWorkItem

The table summarizes the SOAP API - openWorkItem.

Request Uses the openWorkItem element (from the WorkItemManagementService schema)
Parameter notes
  • workItemID: ID of the work item for which information to be opened.
  • version: (Optional). If it is omitted, the latest version is used.
Response Returns an openWorkItemResponse 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:openWorkItem>
         <workItemID id="24" version="0"/>
      </api:openWorkItem>
   </soapenv:Body>
</soapenv:Envelope>
  Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <openWorkItemResponse xmlns="http://api.brm.n2.tibco.com">
         <workItemBody xmlns="">
            <dataModel>
               <inouts array="false" name="Lname" type="String">
                  <simpleSpec>
                     <value>Fur</value>
                  </simpleSpec>
               </inouts>
               <inouts array="false" name="Address1st" type="String">
                  <simpleSpec>
                     <value>666 Hades Gate</value>
                  </simpleSpec>
               </inouts>
               <inouts array="false" name="Gender" type="String">
                  <simpleSpec>
                     <value>F</value>
                  </simpleSpec>
               </inouts>
               <inouts array="false" name="PostCode" type="String">
                  <simpleSpec>
                     <value>HA6 666</value>
                  </simpleSpec>
               </inouts>
               <inouts array="false" name="Fname" type="String">
                  <simpleSpec>
                     <value>Lucy</value>
                  </simpleSpec>
               </inouts>
            </dataModel>
         </workItemBody>
      </openWorkItemResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>