REST API - navigateCaseByCriteria

Request

Format	GET <baseurl>/globaldata/ref/<casereference>/navigate/<rolename>
Path Parameter	caseReference. The case reference of the case data you want to navigate to. For example, `BDS-2-com.example.gddemo.Customer-1-1`. You must only specify one source case reference. roleName: The name of the association. For example, `claim`.
Body	caseCriteria. Contains the parameters in the CaseCriteriaType element (from the BusinessDataServices schema).

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/ref/BDS-2-com.example.gddemo.Customer-12-0/navigate/cars

Body

{

  "xml-fragment": {

    "targetCaseCriteria": {

      "queryString": "engine.model = :engineModel or model = :model",

      "namedParameterAssignment": [

        {

          "name": "engineModel",

          "value": "3%"

        },

        {

          "name": "model",

          "value": "VW"

        }

      ],

      "paginationOptions": { "maxResults": "5" }

    }

  }

}

Response

{

       "xml-fragment":

       {

           "caseReference":

           [

               "BDS-2-com.example.gddemo.Car-15-1",

               "BDS-2-com.example.gddemo.Car-17-1",

               "BDS-2-com.example.gddemo.Car-19-1"

           ]

       }

}