SOAP API - findCaseByExample

The table summarizes the SOAP API - findCaseByExample.

Request Uses the FindCaseByExampleRequest 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 searchable case attributes 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.
  • queryOptions: Specify the pagination options:
    • start (optional). The position in the list of case references from which to start the page of results. The list is zero-based. To start at the first item, specify 0.
    • maxResults (optional). The number of items to include.
Response Returns a FindCaseByExampleResponse 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:FindCaseByExampleRequest>
         <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">
<orderDate>2015-02-04Z</orderDate>
</hastings:OrderElement>
]]>
         </casePayload>
      </api:FindCaseByExampleRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <FindCaseByExampleResponse xmlns="http://api.bds.tibco.com">
         <caseReference xmlns="">BDS-1-com.example.hastings.Order-12-0</caseReference>
         <caseReference xmlns="">BDS-1-com.example.hastings.Order-24-0</caseReference>
         <caseReference xmlns="">BDS-1-com.example.hastings.Order-32-0</caseReference>
      </FindCaseByExampleResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>