REST API - findAllCases

The table summarizes the REST API - findAllCases.

Request

Format 
GET <baseurl>/globaldata/model/<caseType>/<version>/find
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.
Query parameters
  • start=integer (optional). Position in the case reference list from which to start this page. (The list is zero-based. To start at the first item, specify 0.)
  • count=integer (optional). Number of case references to include in this page. Specifying -1 returns all.

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 
GET <baseurl>/globaldata/model/com.example.hastings.Customer/1/find?start=0&count=1
Response 
{
  "xml-fragment": {
    "caseReference": "BDS-1-com.example.hastings.Customer-1-0",
    "hasMoreResults": "true"
  }
}