SOAP API - findCaseByCID

The table summarizes the SOAP API - findCaseByCID.

Request Uses the FindCaseByCIDRequest element (from the BusinessDataServices schema).
Parameter notes
  • caseType: The case type is the fully qualified name of the case class. For example, com.example.hastings.Order. You can obtain class names by using getCaseClassInfo.
  • caseModelVersion: The version of the case model. For example, 1or 1.0.0.
  • casePayload. This contains the case identifier whose case reference you want to retrieve. Your request must be constructed to match the structure of the case data defined in your business object model. See Obtaining Information From TIBCO Business Studio.
Response Returns a FindCaseByCIDResponse 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:FindCaseByCIDRequest>
         <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:FindCaseByCIDRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <FindCaseByCIDResponse xmlns="http://api.bds.tibco.com">
         <caseReference xmlns="">BDS-1-com.example.hastings.Order-1-0</caseReference>
      </FindCaseByCIDResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>