table-rows

Search a table's cells

Find cells whose text contains the query, anywhere in the table, and report where each one sits in the listing the client is currently showing, so the grid can scroll to a match rather than only highlight the page it is on. TEXT columns only: a number or a date would have to be rendered to be matched as text, and how it renders is a client-side question, so a server-side answer could disagree with the cell on screen. Send the grid's current sorts and where; an offset counted against a different listing points at the wrong row.

post/tables/{table_id}/rows/search/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/tables/{table_id}/rows/search/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

table_idstring uuid required

Request body

column_idsstring[] nullable

Restrict the search to these columns; omit to search every text column.

querystring required

The substring to look for; matched case-insensitively.

Response

Successful Response

limitinteger required

The cap that was applied.

total_matchedinteger required

Matches found, before the cap.

truncatedboolean required

Whether more matches exist than were returned.

Changes

No recorded changes to this operation across all 1 revision of this API.