選取多條記錄
在查詢中指定一個條件以選取多條記錄。
- 一次最多可以選取 500 條記錄。
可選取的記錄數在query
參數limit
中指定。
limit
的初始值為 100。 - 參數的最大
query
參數offset
值為 10,000 *1 - 如果要在查詢中搜索字串,則為單詞搜索。有關詳細資訊,請參閱 輸入搜索關鍵字的注意事項 。
- 如果搜索的查詢中有超過 100,000 條記錄,則優化將暫停。
在這種情況下,在回應頭的“X-Cybozu-Warning”中會添加“Filter aborted because of too many search results”。
*1 2020 年 7 月,我們進行了更改,在計劃維護期間將偏移值限製為 10,000。
如果獲取的記錄數量可能超過 10,000 條,請檢查正在運行和應用的程式,並考慮更正它。
更多資訊,
請參見關於 kintone考慮偏移限制的記錄批量檢索。
^
URL
- 常規應用程式
- https://sample.cybozu.com/k/v1/records.json
- 訪客空間的應用程式
- https://sample.cybozu.com/k/guest/
GUEST_SPACE_ID
/v1/records.json
HTTP 方法
GET
所需應用程式
- 查看應用程式中記錄的許可權
- 查看要選取其值的記錄的許可權
- 查看要選取其值的欄位的許可權
請求
參數
參數名稱 | 類型 | 必須 | 說明 |
---|---|---|---|
app | 數位或字串 | 必須 | 應用ID |
fields | 字串陣列 | 可省略 | 要包含在回應中的域代碼 如果省略,則返回您有權查看的所有欄位的值。 如果在請求內文中 fields 指定,則最多可以指定 1,000 個欄位代碼。如果在查詢字串中 fields 指定,fields 則下標可以介於 0 到 99 之間。 |
query | 字串 | 可省略 | 一個查詢字串,用於指定要包含在回應中的記錄的條件 有關查詢表示法,請參閱 如何編寫查詢。 如果省略,則選取您有權查看的所有記錄。 |
totalCount | 布爾值或字串 | 可省略 | query 是否檢索與中指定的條件匹配的記錄數
|
範例請求(如果在網址中包含參數 )
將 URL 編碼的參數作為 HTTP 查詢字串發送。
URL
例如,假設您將以下參數指定為 API 的查詢字串:
|
|
在本例中,URL 如下所示:
https://sample.cybozu.com/k/v1/records.json?app=1&query=%E6%9B%B4%E6%96%B0%E6%99%82%E9%96%93+%3E+%222012-02-03T09%3A00%3A00%2B0900%22+and+%E6%9B%B4%E6%96%B0%E6%99%82%E9%96%93+%3C+%222012-02-03T10%3A00%3A00%2B0900%22+order+by+%E8%A8%98%E9%8C%84%E8%99%9F%E7%A2%BC+asc+limit+10+offset+1%26fields%5B0%5D%3D%E8%A8%98%E9%8C%84%E8%99%9F%E7%A2%BC%26fields%5B1%5D%3D%E5%BB%BA%E7%AB%8B%E6%99%82%E9%96%93%26fields%5B2%5D%3D%E4%B8%8B%E6%8B%89%E5%BC%8F%E9%81%B8%E5%96%AE%0D%0A
標頭
|
|
關於請求標頭,請參見 kintone REST API的通用規範。
範例要求(如果要在要求內文中包含參數)
URL
https://sample.cybozu.com/k/v1/records.json
標頭
|
|
關於請求標頭,請參見 kintone REST API的通用規範。
內文
如果要對在
查詢運算子 中指定值時所需的"
(雙引號)進行轉義,請使用 \
(反斜杠)對其進行轉義。
|
|
回應
屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
records | 陣列(物件) | 記錄清單 有關欄位格式,請參閱 欄位格式。 |
totalCount | 字串 | 新增記錄 如果為請求參數 totalCount 指定或省略“false”,則返回“null”。 |
示例代碼
使用 curl 的請求
|
|
發送kintone REST API請求 使用API 發送請求
|
|