cURL
curl --request PATCH \
--url https://app.teable.ai/api/table/%7BtableId%7D/selection/clear-by-id \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{"viewId":"viwXXXXXXX","ignoreViewQuery":"string","filterByTql":"{field} = '\''Completed'\'' AND {field} > 5","filter":"string","search":["searchValue","fieldIdOrName",false],"filterLinkCellCandidate":["fldXXXXXXX","recXXXXXXX"],"filterLinkCellSelected":["fldXXXXXXX","recXXXXXXX"],"selectedRecordIds":["string"],"orderBy":"string","groupBy":"string","collapsedGroupIds":"string","queryId":"qry_xxxxxxxx","includeQueryExtra":"string","projection":["string"],"selection":{"recordIds":["string"],"excludeRecordIds":["string"],"fieldIds":["string"]}}'const url = 'https://app.teable.ai/api/table/%7BtableId%7D/selection/clear-by-id';
const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer REPLACE_BEARER_TOKEN',
'content-type': 'application/json'
},
body: '{"viewId":"viwXXXXXXX","ignoreViewQuery":"string","filterByTql":"{field} = \'Completed\' AND {field} > 5","filter":"string","search":["searchValue","fieldIdOrName",false],"filterLinkCellCandidate":["fldXXXXXXX","recXXXXXXX"],"filterLinkCellSelected":["fldXXXXXXX","recXXXXXXX"],"selectedRecordIds":["string"],"orderBy":"string","groupBy":"string","collapsedGroupIds":"string","queryId":"qry_xxxxxxxx","includeQueryExtra":"string","projection":["string"],"selection":{"recordIds":["string"],"excludeRecordIds":["string"],"fieldIds":["string"]}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const http = require('https');
const options = {
method: 'PATCH',
hostname: 'app.teable.ai',
port: null,
path: '/api/table/%7BtableId%7D/selection/clear-by-id',
headers: {
Authorization: 'Bearer REPLACE_BEARER_TOKEN',
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
viewId: 'viwXXXXXXX',
ignoreViewQuery: 'string',
filterByTql: '{field} = \'Completed\' AND {field} > 5',
filter: 'string',
search: ['searchValue', 'fieldIdOrName', false],
filterLinkCellCandidate: ['fldXXXXXXX', 'recXXXXXXX'],
filterLinkCellSelected: ['fldXXXXXXX', 'recXXXXXXX'],
selectedRecordIds: ['string'],
orderBy: 'string',
groupBy: 'string',
collapsedGroupIds: 'string',
queryId: 'qry_xxxxxxxx',
includeQueryExtra: 'string',
projection: ['string'],
selection: {recordIds: ['string'], excludeRecordIds: ['string'], fieldIds: ['string']}
}));
req.end();import http.client
conn = http.client.HTTPSConnection("app.teable.ai")
payload = "{\"viewId\":\"viwXXXXXXX\",\"ignoreViewQuery\":\"string\",\"filterByTql\":\"{field} = 'Completed' AND {field} > 5\",\"filter\":\"string\",\"search\":[\"searchValue\",\"fieldIdOrName\",false],\"filterLinkCellCandidate\":[\"fldXXXXXXX\",\"recXXXXXXX\"],\"filterLinkCellSelected\":[\"fldXXXXXXX\",\"recXXXXXXX\"],\"selectedRecordIds\":[\"string\"],\"orderBy\":\"string\",\"groupBy\":\"string\",\"collapsedGroupIds\":\"string\",\"queryId\":\"qry_xxxxxxxx\",\"includeQueryExtra\":\"string\",\"projection\":[\"string\"],\"selection\":{\"recordIds\":[\"string\"],\"excludeRecordIds\":[\"string\"],\"fieldIds\":[\"string\"]}}"
headers = {
'Authorization': "Bearer REPLACE_BEARER_TOKEN",
'content-type': "application/json"
}
conn.request("PATCH", "/api/table/%7BtableId%7D/selection/clear-by-id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.teable.ai/api/table/{tableId}/selection/clear-by-id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'selection' => [
'recordIds' => [
'<string>'
],
'excludeRecordIds' => [
'<string>'
],
'fieldIds' => [
'<string>'
]
],
'viewId' => 'viwXXXXXXX',
'ignoreViewQuery' => '<string>',
'filterByTql' => '{field} = \'Completed\' AND {field} > 5',
'filter' => '<string>',
'search' => [
'searchValue',
'fieldIdOrName',
false
],
'filterLinkCellCandidate' => [
'fldXXXXXXX',
'recXXXXXXX'
],
'filterLinkCellSelected' => [
'fldXXXXXXX',
'recXXXXXXX'
],
'selectedRecordIds' => [
'<string>'
],
'orderBy' => '<string>',
'groupBy' => '<string>',
'collapsedGroupIds' => '<string>',
'queryId' => 'qry_xxxxxxxx',
'includeQueryExtra' => '<string>',
'projection' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.teable.ai/api/table/{tableId}/selection/clear-by-id"
payload := strings.NewReader("{\n \"selection\": {\n \"recordIds\": [\n \"<string>\"\n ],\n \"excludeRecordIds\": [\n \"<string>\"\n ],\n \"fieldIds\": [\n \"<string>\"\n ]\n },\n \"viewId\": \"viwXXXXXXX\",\n \"ignoreViewQuery\": \"<string>\",\n \"filterByTql\": \"{field} = 'Completed' AND {field} > 5\",\n \"filter\": \"<string>\",\n \"search\": [\n \"searchValue\",\n \"fieldIdOrName\",\n false\n ],\n \"filterLinkCellCandidate\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"filterLinkCellSelected\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"selectedRecordIds\": [\n \"<string>\"\n ],\n \"orderBy\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"collapsedGroupIds\": \"<string>\",\n \"queryId\": \"qry_xxxxxxxx\",\n \"includeQueryExtra\": \"<string>\",\n \"projection\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.teable.ai/api/table/{tableId}/selection/clear-by-id")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"selection\": {\n \"recordIds\": [\n \"<string>\"\n ],\n \"excludeRecordIds\": [\n \"<string>\"\n ],\n \"fieldIds\": [\n \"<string>\"\n ]\n },\n \"viewId\": \"viwXXXXXXX\",\n \"ignoreViewQuery\": \"<string>\",\n \"filterByTql\": \"{field} = 'Completed' AND {field} > 5\",\n \"filter\": \"<string>\",\n \"search\": [\n \"searchValue\",\n \"fieldIdOrName\",\n false\n ],\n \"filterLinkCellCandidate\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"filterLinkCellSelected\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"selectedRecordIds\": [\n \"<string>\"\n ],\n \"orderBy\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"collapsedGroupIds\": \"<string>\",\n \"queryId\": \"qry_xxxxxxxx\",\n \"includeQueryExtra\": \"<string>\",\n \"projection\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.teable.ai/api/table/{tableId}/selection/clear-by-id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"selection\": {\n \"recordIds\": [\n \"<string>\"\n ],\n \"excludeRecordIds\": [\n \"<string>\"\n ],\n \"fieldIds\": [\n \"<string>\"\n ]\n },\n \"viewId\": \"viwXXXXXXX\",\n \"ignoreViewQuery\": \"<string>\",\n \"filterByTql\": \"{field} = 'Completed' AND {field} > 5\",\n \"filter\": \"<string>\",\n \"search\": [\n \"searchValue\",\n \"fieldIdOrName\",\n false\n ],\n \"filterLinkCellCandidate\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"filterLinkCellSelected\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"selectedRecordIds\": [\n \"<string>\"\n ],\n \"orderBy\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"collapsedGroupIds\": \"<string>\",\n \"queryId\": \"qry_xxxxxxxx\",\n \"includeQueryExtra\": \"<string>\",\n \"projection\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyselection
Clear selected records and fields by id
Clear selected cells using record and field identifiers instead of row ranges.
Required token scopes: record|update
PATCH
/
table
/
{tableId}
/
selection
/
clear-by-id
cURL
curl --request PATCH \
--url https://app.teable.ai/api/table/%7BtableId%7D/selection/clear-by-id \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
--header 'content-type: application/json' \
--data '{"viewId":"viwXXXXXXX","ignoreViewQuery":"string","filterByTql":"{field} = '\''Completed'\'' AND {field} > 5","filter":"string","search":["searchValue","fieldIdOrName",false],"filterLinkCellCandidate":["fldXXXXXXX","recXXXXXXX"],"filterLinkCellSelected":["fldXXXXXXX","recXXXXXXX"],"selectedRecordIds":["string"],"orderBy":"string","groupBy":"string","collapsedGroupIds":"string","queryId":"qry_xxxxxxxx","includeQueryExtra":"string","projection":["string"],"selection":{"recordIds":["string"],"excludeRecordIds":["string"],"fieldIds":["string"]}}'const url = 'https://app.teable.ai/api/table/%7BtableId%7D/selection/clear-by-id';
const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer REPLACE_BEARER_TOKEN',
'content-type': 'application/json'
},
body: '{"viewId":"viwXXXXXXX","ignoreViewQuery":"string","filterByTql":"{field} = \'Completed\' AND {field} > 5","filter":"string","search":["searchValue","fieldIdOrName",false],"filterLinkCellCandidate":["fldXXXXXXX","recXXXXXXX"],"filterLinkCellSelected":["fldXXXXXXX","recXXXXXXX"],"selectedRecordIds":["string"],"orderBy":"string","groupBy":"string","collapsedGroupIds":"string","queryId":"qry_xxxxxxxx","includeQueryExtra":"string","projection":["string"],"selection":{"recordIds":["string"],"excludeRecordIds":["string"],"fieldIds":["string"]}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const http = require('https');
const options = {
method: 'PATCH',
hostname: 'app.teable.ai',
port: null,
path: '/api/table/%7BtableId%7D/selection/clear-by-id',
headers: {
Authorization: 'Bearer REPLACE_BEARER_TOKEN',
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
viewId: 'viwXXXXXXX',
ignoreViewQuery: 'string',
filterByTql: '{field} = \'Completed\' AND {field} > 5',
filter: 'string',
search: ['searchValue', 'fieldIdOrName', false],
filterLinkCellCandidate: ['fldXXXXXXX', 'recXXXXXXX'],
filterLinkCellSelected: ['fldXXXXXXX', 'recXXXXXXX'],
selectedRecordIds: ['string'],
orderBy: 'string',
groupBy: 'string',
collapsedGroupIds: 'string',
queryId: 'qry_xxxxxxxx',
includeQueryExtra: 'string',
projection: ['string'],
selection: {recordIds: ['string'], excludeRecordIds: ['string'], fieldIds: ['string']}
}));
req.end();import http.client
conn = http.client.HTTPSConnection("app.teable.ai")
payload = "{\"viewId\":\"viwXXXXXXX\",\"ignoreViewQuery\":\"string\",\"filterByTql\":\"{field} = 'Completed' AND {field} > 5\",\"filter\":\"string\",\"search\":[\"searchValue\",\"fieldIdOrName\",false],\"filterLinkCellCandidate\":[\"fldXXXXXXX\",\"recXXXXXXX\"],\"filterLinkCellSelected\":[\"fldXXXXXXX\",\"recXXXXXXX\"],\"selectedRecordIds\":[\"string\"],\"orderBy\":\"string\",\"groupBy\":\"string\",\"collapsedGroupIds\":\"string\",\"queryId\":\"qry_xxxxxxxx\",\"includeQueryExtra\":\"string\",\"projection\":[\"string\"],\"selection\":{\"recordIds\":[\"string\"],\"excludeRecordIds\":[\"string\"],\"fieldIds\":[\"string\"]}}"
headers = {
'Authorization': "Bearer REPLACE_BEARER_TOKEN",
'content-type': "application/json"
}
conn.request("PATCH", "/api/table/%7BtableId%7D/selection/clear-by-id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.teable.ai/api/table/{tableId}/selection/clear-by-id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'selection' => [
'recordIds' => [
'<string>'
],
'excludeRecordIds' => [
'<string>'
],
'fieldIds' => [
'<string>'
]
],
'viewId' => 'viwXXXXXXX',
'ignoreViewQuery' => '<string>',
'filterByTql' => '{field} = \'Completed\' AND {field} > 5',
'filter' => '<string>',
'search' => [
'searchValue',
'fieldIdOrName',
false
],
'filterLinkCellCandidate' => [
'fldXXXXXXX',
'recXXXXXXX'
],
'filterLinkCellSelected' => [
'fldXXXXXXX',
'recXXXXXXX'
],
'selectedRecordIds' => [
'<string>'
],
'orderBy' => '<string>',
'groupBy' => '<string>',
'collapsedGroupIds' => '<string>',
'queryId' => 'qry_xxxxxxxx',
'includeQueryExtra' => '<string>',
'projection' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.teable.ai/api/table/{tableId}/selection/clear-by-id"
payload := strings.NewReader("{\n \"selection\": {\n \"recordIds\": [\n \"<string>\"\n ],\n \"excludeRecordIds\": [\n \"<string>\"\n ],\n \"fieldIds\": [\n \"<string>\"\n ]\n },\n \"viewId\": \"viwXXXXXXX\",\n \"ignoreViewQuery\": \"<string>\",\n \"filterByTql\": \"{field} = 'Completed' AND {field} > 5\",\n \"filter\": \"<string>\",\n \"search\": [\n \"searchValue\",\n \"fieldIdOrName\",\n false\n ],\n \"filterLinkCellCandidate\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"filterLinkCellSelected\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"selectedRecordIds\": [\n \"<string>\"\n ],\n \"orderBy\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"collapsedGroupIds\": \"<string>\",\n \"queryId\": \"qry_xxxxxxxx\",\n \"includeQueryExtra\": \"<string>\",\n \"projection\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.teable.ai/api/table/{tableId}/selection/clear-by-id")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"selection\": {\n \"recordIds\": [\n \"<string>\"\n ],\n \"excludeRecordIds\": [\n \"<string>\"\n ],\n \"fieldIds\": [\n \"<string>\"\n ]\n },\n \"viewId\": \"viwXXXXXXX\",\n \"ignoreViewQuery\": \"<string>\",\n \"filterByTql\": \"{field} = 'Completed' AND {field} > 5\",\n \"filter\": \"<string>\",\n \"search\": [\n \"searchValue\",\n \"fieldIdOrName\",\n false\n ],\n \"filterLinkCellCandidate\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"filterLinkCellSelected\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"selectedRecordIds\": [\n \"<string>\"\n ],\n \"orderBy\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"collapsedGroupIds\": \"<string>\",\n \"queryId\": \"qry_xxxxxxxx\",\n \"includeQueryExtra\": \"<string>\",\n \"projection\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.teable.ai/api/table/{tableId}/selection/clear-by-id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"selection\": {\n \"recordIds\": [\n \"<string>\"\n ],\n \"excludeRecordIds\": [\n \"<string>\"\n ],\n \"fieldIds\": [\n \"<string>\"\n ]\n },\n \"viewId\": \"viwXXXXXXX\",\n \"ignoreViewQuery\": \"<string>\",\n \"filterByTql\": \"{field} = 'Completed' AND {field} > 5\",\n \"filter\": \"<string>\",\n \"search\": [\n \"searchValue\",\n \"fieldIdOrName\",\n false\n ],\n \"filterLinkCellCandidate\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"filterLinkCellSelected\": [\n \"fldXXXXXXX\",\n \"recXXXXXXX\"\n ],\n \"selectedRecordIds\": [\n \"<string>\"\n ],\n \"orderBy\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"collapsedGroupIds\": \"<string>\",\n \"queryId\": \"qry_xxxxxxxx\",\n \"includeQueryExtra\": \"<string>\",\n \"projection\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body承認
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
パスパラメータ
ボディ
application/json
Show child attributes
Show child attributes
Set the view you want to fetch. When provided, records will follow that view's filter and sort settings. When omitted, the API queries the table without applying a view.
例:
"viwXXXXXXX"
When a viewId is specified, configure this to true will ignore the view's filter, sort, etc
例:
"{field} = 'Completed' AND {field} > 5"
A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters.
Search for records that match the specified field and value
Required array length:
1 elementFilter 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.
Required array length:
2 elements例:
["fldXXXXXXX", "recXXXXXXX"]
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
Required array length:
2 elements例:
["fldXXXXXXX", "recXXXXXXX"]
Filter selected records by record ids
An array of sort objects that specifies how the records should be ordered.
An array of group objects that specifies how the records should be grouped.
An array of group ids that specifies which groups are collapsed
When provided, other query parameters will be merged with the saved ones.
例:
"qry_xxxxxxxx"
Whether to include query extra metadata such as group points and search hit indexes. Group metadata defaults to enabled; optimized generated-index searches require explicit opt-in for search hit indexes.
Visible field ids for query-scoped field selection. If omitted, all visible view fields are used.
レスポンス
200
Successful clean up
最終更新日 2026年9月15日
このページは役に立ちましたか？