REST API - navigateCase

The table summarizes the REST API - navigateCase.

Request

Format 
GET <baseurl>/globaldata/ref/<casereference>/navigate/<rolename>
Path Parameter s
  • caseReference. The case reference of the case data that has data associated with it. For example, a customer. You must specify only one source case reference.
  • rolename: The name of the association that was specified when the association was created using linkCase . For example, claim.
Query Parameters
  • start=integer (optional, default=0). 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, default =-1). Number of case references to include in this page. Specifying -1 returns all.

Response

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

Example

Request 
GET <baseurl>/globaldata/ref/BDS-2-com.example.gddemo.Customer-5-0/navigate/cars
Response 
{
       "xml-fragment":
       {
           "caseReference":
           [
               "BDS-2-com.example.gddemo.Car-8-1",
               "BDS-2-com.example.gddemo.Car-10-1"
           ]
       }
}