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.

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

   <soapenv:Body>

      <api:closeWorkItem>

         <workItemID id="23"/>

         <workItemPayload>

            <dataModel>

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

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

                  <!--You have a CHOICE of the next 2 items at this level-->

                  <!--Optional:-->

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

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

                     <value>?</value>

                  </simpleSpec>

                  <!--Optional:-->

                  <complexSpec className="?">

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

                     <value>?</value>

                  </complexSpec>

               </inputs>

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

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

                  <!--You have a CHOICE of the next 2 items at this level-->

                  <!--Optional:-->

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

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

                     <value>?</value>

                  </simpleSpec>

                  <!--Optional:-->

                  <complexSpec className="?">

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

                     <value>?</value>

                  </complexSpec>

               </outputs>

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

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

                  <!--You have a CHOICE of the next 2 items at this level-->

                  <!--Optional:-->

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

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

                     <value>?</value>

                  </simpleSpec>

                  <!--Optional:-->

                  <complexSpec className="?">

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

                     <value>?</value>

                  </complexSpec>

               </inouts>

            </dataModel>

         </workItemPayload>

         <hiddenPeriod>
 
<!--You have a CHOICE of the next 2 items at this level-->

  <hiddenDuration years="0" months="0" weeks="0" days="2" hours="0" minutes="0"/>

         </hiddenPeriod>

      </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="23" version="4" xmlns=""/>

      </closeWorkItemResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>