PATCH
/
table
/
{tableId}
/
selection
/
clear
curl --request PATCH \
  --url https://app.teable.io/api/table/%7BtableId%7D/selection/clear \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"viewId":"viwXXXXXXX","ignoreViewQuery":"string","filterByTql":"{field} = '\''Completed'\'' AND {field} > 5","filter":{},"search":["searchValue","fieldIdOrName",false],"filterLinkCellCandidate":["fldXXXXXXX","recXXXXXXX"],"filterLinkCellSelected":["fldXXXXXXX","recXXXXXXX"],"selectedRecordIds":["string"],"orderBy":[],"groupBy":[{"fieldId":"string","order":"asc"}],"collapsedGroupIds":["string"],"projection":["string"],"ranges":[[0,0],[1,1]],"type":"columns"}'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tableId
string
required

Body

application/json
​
ranges
array
required

The parameter "ranges" is used to represent the coordinates of a selected range in a table.

​
viewId
string

Set the view you want to fetch, default is first view. result will filter and sort by view options.

​
ignoreViewQuery

When a viewId is specified, configure this to true will ignore the view's filter, sort, etc

​
filterByTql
string
deprecated
​
filter
object

A filter object used to filter results. It allows complex query conditions based on fields, operators, and values.

​
search

Search for records that match the specified field and value

​
filterLinkCellCandidate

Filter out the records that can be selected by a given link cell from the relational table. For example, if the specified field is one to many or one to one relationship, recordId for which the field has already been selected will not appear.

​
filterLinkCellSelected

Filter out selected records based on this link cell from the relational table. Note that viewId, filter, and orderBy will not take effect in this case because selected records has it own order. Ignoring recordId gets all the selected records for the field

​
selectedRecordIds
string[]

Filter selected records by record ids

​
orderBy
any[]

An array of sort objects that specifies how the records should be ordered.

​
groupBy
object[] | null
​
collapsedGroupIds
string[]

An array of group ids that specifies which groups are collapsed

​
projection
string[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained

​
type
enum<string>

Types of non-contiguous selections

Available options:
rows,
columns
Previous
Copy selected table content
Next