REST API - findCaseByCriteria

The table summarizes the REST API - findCaseByCriteria.

Request

Format
POST <baseurl>/globaldata/model/<caseType>/<version>/findbyquery
Path parameters
  • caseType: The case type is the fully qualified name of the case class. For example, com.example.gddemo.Customer. You can obtain this by running getCaseClassInfo .
  • version: The version of the case model. For example, 2 or 2.0.0.
Body caseCriteriaType: the parameters from the CaseCriteriaType element (from the BusinessDataServices schema) that defines the criteria to be evaluated. For valid syntax, see TIBCO Business Data Services Guide.

Response

JSON Returns a JSON representation of the contents of a SearchResults element.
XML Returns the contents of a SearchResults element (from the BusinessDataServices schema)

Example

Request
POST <baseurl>/globaldata/model/com.example.gddemo.Car/2/findbyquery
Body
<xml-fragment>

<queryString>engine.model = :model order by vehicleID

desc</queryString>

<namedParameterAssignment>

<name>model</name>

<value>1.6%</value>

</namedParameterAssignment>

<paginationOptions>

<startPosition>1</startPosition>

<maxResults>-1</maxResults>

</paginationOptions>

</xml-fragment>
Response
{

"xml-fragment":

       {

           "caseReference":

           [

               "BDS-2-com.example.gddemo.Car-42-0",

               "BDS-2-com.example.gddemo.Car-33-0"

           ],

           "hasMoreResults": false

}

}