Skip to content

Search

Full-text and pattern search across all entity classes the current user has access to.

GET /api/search/{searchTerm}

Search using all available modes simultaneously (exact, like, and full-text). Returns a merged and ranked result set.

Request

Path parameters

  • searchTerm The search query

Query parameters

  • $filter Optional OData filter to narrow results to specific entity classes or properties

Response

A list of matching entity objects from all accessible entity classes.

Example 1

Search for “FERM-001” across all entities:

GET /api/search/FERM-001

Example 2

Search for “glucose” limited to Experiments:

GET /api/search/glucose?$filter=eClass eq 'Experiment'

GET /api/search/exact/{searchTerm}

Search for entities with an exact match on ID, name, or barcode.

Request

Path parameters

  • searchTerm The exact value to search for

Query parameters

  • $filter Optional OData filter

GET /api/search/like/{searchTerm}

Search for entities where name, ID, or barcode contains the search term (SQL LIKE pattern).

Request

Path parameters

  • searchTerm The search string

Query parameters

  • $filter Optional OData filter

GET /api/search/fulltext/{searchTerm}

Search using the database full-text index. More comprehensive than like-search but requires the full-text index to be configured on the database.

Request

Path parameters

  • searchTerm The full-text search query

Query parameters

  • $filter Optional OData filter