SOAP API - closeWorkItem

The table summarizes the SOAP API - closeWorkItem.

Request Uses the closeWorkItem element (from the WorkItemManagementService schema)
Parameter notes
  • workItemID: ID of the work item to be closed.
  • 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 Close action.

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

  • hiddenPeriod: information about how long the work item is to be hidden. Either a duration for which it is to be hidden, or the date and time when it is to become visible. A hiddenPeriod of 0 cancels any current hiddenPeriod. See Accessing Hidden Work Items for more details.
Response Returns a closeWorkItemResponse 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:closeWorkItem>
         <workItemID id="37"/>
         <workItemPayload>
            <dataModel>
               <inputs array="false" name="IssueDescription" type="String">
                  <simpleSpec>
                     <value>Forgot password</value>
                  </simpleSpec>
               </inputs>
               <inputs array="false" name="IssueDetails" type="String">
                  <simpleSpec>
                     <value>Please reset password</value>
                  </simpleSpec>
               </inputs>
               <inouts array="false" name="ResolutionDetails" type="String">
                  <simpleSpec/>
               </inouts>
               <inouts array="false" name="ResolutionDescription" type="String">
                  <simpleSpec/>
               </inouts>
            </dataModel>
         </workItemPayload>
      </api:closeWorkItem>
   </soapenv:Body>
</soapenv:Envelope>
  Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <closeWorkItemResponse xmlns="http://api.brm.n2.tibco.com">
         <workItemID id="37" version="3" xmlns=""/>
      </closeWorkItemResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>