SOAP API - deleteCaseByCID

The table summarizes the SOAP API - deleteCaseByCID.

Request Uses the DeleteCaseByCIDRequest element (from the BusinessDataServices schema)
Parameter notes
  • caseType: The case type is the fully qualified name of the case class. For example, com.example.gddemo.Car. You can obtain class names by using getCaseClassInfo .
  • caseModelVersion: The version of the case model. For example, 2 or 2.0.0.
  • casePayload. This contains the case identifier of the case to be deleted. The case payload must be constructed to match the structure of the case data defined in your business object model. There can be more than one casePayload if multiple objects are being deleted. See Obtaining Information From TIBCO Business Studio .
Response Returns a DeleteCaseByCIDResponse element (from the BusinessDataServices schema)
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.bds.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:DeleteCaseByCIDRequest>
         <caseModelVersion>1</caseModelVersion>
         <caseType>com.example.hastings.Order</caseType>
         <casePayload>
          <![CDATA[
<hastings:OrderElement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:hastings="http://example.com/hastings" xsi:type="hastings:Order">
<orderNum>776564</orderNum>
</hastings:OrderElement>
]]>       
         </casePayload>
      </api:DeleteCaseByCIDRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <DeleteCaseByCIDResponse xmlns="http://api.bds.tibco.com"/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>