SOAP API - pendWorkItem

The table summarizes the SOAP API - pendWorkItem.

Request Uses the pendWorkItemelement (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.
  • 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 pendWorkItemResponseelement (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:pendWorkItem>
         <workItemID id="3" version=""/>
         <hiddenPeriod>
            <hiddenDuration years="0" months="0" weeks="0" days="0" hours="0" minutes="5"/>
            <visibleDate>2011-07-23T14:25:10</visibleDate>
         </hiddenPeriod>
      </api:pendWorkItem>
   </soapenv:Body>
</soapenv:Envelope>
Response:
SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <pendWorkItemResponse xmlns="http://api.brm.n2.tibco.com">
         <workItemID id="3" version="11" xmlns=""/>
      </pendWorkItemResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>