freeTextSearch: Search Example

The free text search functions similarly to a filter, except it searches all fields simultaneously.

Example 1: Search for entities with an exact value in any attribute

Search:

  • Use the search API: Device Search
  • Match the any attribute that has a valueR21468772
  • Limit the number of results to 10 per page
  • Return the first page

Filter object will look like this:

{
  "freeTextSearch": "R21468772",
  "limit": 10,
  "page": 0
}

Encoded API call:

https://api.dev.example.biot-med.com/device/v2/devices?searchRequest=%7B%0A%20%20%22freeTextSearch%22%3A%20%22R21468772%22%2C%0A%20%20%22limit%22%3A%2010%2C%0A%20%20%22page%22%3A%200%0A%7D