選取多條記錄

連結已複製

在查詢中指定一個條件以選取多條記錄。

HTTP 方法	取得
URL	https://sample.cybozu.com/k/v1/records.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/records.json
認證	密碼驗證 , API 令牌認證 , 會話認證 , OAuth認證
Content-Type	application/json（在URL中包含參數時不需指定此項）

請求參數

連結已複製

參數名稱	類型	必須	說明
app	數值或字串	必須	應用ID
fields	字串陣列	可省略	要包含在回應中的欄位代碼如果省略，則返回您有權查看的所有欄位的值。如果在請求正文中指定 `fields` ，則最多可以指定 1,000 個欄位代碼。如果在查詢字串中指定`fields` ，`fields` 則下標可以介於 0 到 99 之間。無法將表格內的欄位指定為複製目標。如果要隱藏表中的所有欄位，請指定表的欄位代碼。將獲取表中的所有欄位。
query	字串	可省略	一個查詢字串，用於指定要包含在回應中的記錄的條件有關查詢表示法的詳細資訊，請參閱以下頁面。如何編寫查詢如果省略，則選取您有權查看的所有記錄。
totalCount	布爾值或字串	可省略	`query` 是否獲取與中指定的條件匹配的記錄數 `true`：獲取案例數 `false`：不獲取案例數

回應屬性

連結已複製

屬性名稱	類型	說明
records	陣列（物件）	記錄清單有關欄位格式，請參閱以下頁面。欄位格式
totalCount	字串	新增記錄如果為請求參數 `totalCount` 指定或省略「false」，則返回「null」。

所需存取權限

連結已複製

應用程式的記錄的查看權限
要選取其值的記錄的查看權限
查看要選取其值的欄位的查看權限

範例

連結已複製

請求範例

請求URL（在URL中包含參數的情況）

將 URL 編碼的參數作為 HTTP 查詢字串發送。例如，指定以下參數時：

1

app=1&query=更新時間 > "2012-02-03T09:00:00+0900" and 更新時間 < "2012-02-03T10:00:00+0900" order by 記錄號碼 asc limit 10 offset 1&fields[0]=記錄號碼&fields[1]=建立時間&fields[2]=下拉式選單

在本例中，URL 如下所示：

1

https://sample.cybozu.com/k/v1/records.json?app=1&query=%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3E%20%222012-02-03T09%3A00%3A00%2B0900%22%20and%20%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3C%20%222012-02-03T10%3A00%3A00%2B0900%22%20order%20by%20%e3%83%ac%e3%82%b3%e3%83%bc%e3%83%89%e7%95%aa%e5%8f%b7%20asc%20limit%2010%20offset%201&fields%5B0%5D=%e3%83%ac%e3%82%b3%e3%83%bc%e3%83%89%e7%95%aa%e5%8f%b7&fields%5B1%5D=%e4%bd%9c%e6%88%90%e6%97%a5%e6%99%82&fields%5B2%5D=%e3%83%89%e3%83%ad%e3%83%83%e3%83%97%e3%83%80%e3%82%a6%e3%83%b3

請求標頭（在URL中包含參數的情況）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規格

請求URL（在請求主體中包含參數的情況）

1

https://sample.cybozu.com/k/v1/records.json

請求標頭（在請求主體中包含參數的情況）

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規格

請求主體（在請求主體中包含參數的情況）

用查詢運算子指定值時，如要對必要的（雙引號）進行跳脫處理，請用`（反斜槓）進行跳脫。
查詢運算子

1
2
3
4
5


{
  "app": 1,
  "query": "更新日期與時間 > \"2025-02-03T09:00:00+0900\" and 更新日期與時間 < \"2025-02-03T10:00:00+0900\" order by 紀錄號碼 asc limit 10 offset 1",
  "fields": ["記錄編號", "建立時間", "下拉式選單"]
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送kintone REST API請求

1
2
3
4
5
6
7


const body = {
  app: kintone.app.getId(),
  query: '更新日期與時間 > "2025-02-03T09:00:00+0900" and 更新日期與時間 < "2025-02-03T10:00:00+0900" order by 記錄號碼 asc limit 10 offset 1',
  fields: ['記錄編號', '建立時間', '下拉式選單']
};

await kintone.api(kintone.api.url('/k/v1/records.json', true), 'GET', body);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

1
2


curl -X GET 'https://sample.cybozu.com/k/v1/records.json?app=1&query=%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3E%20%222012-02-03T09%3A00%3A00%2B0900%22%20and%20%e6%9b%b4%e6%96%b0%e6%97%a5%e6%99%82%20%3C%20%222012-02-03T10%3A00%3A00%2B0900%22%20order%20by%20%e3%83%ac%e3%82%b3%e3%83%bc%e3%83%89%e7%95%aa%e5%8f%b7%20asc%20limit%2010%20offset%201&fields%5B0%5D=%e3%83%ac%e3%82%b3%e3%83%bc%e3%83%89%e7%95%aa%e5%8f%b7&fields%5B1%5D=%e4%bd%9c%e6%88%90%e6%97%a5%e6%99%82&fields%5B2%5D=%e3%83%89%e3%83%ad%e3%83%83%e3%83%97%e3%83%80%e3%82%a6%e3%83%b3' \
  -H 'X-Cybozu-API-Token: API_TOKEN'

補充

連結已複製

一次最多可以選取 500 條記錄。
可以獲取的記錄數由 query 參數的limit指定。
query參數名稱的limit
limit的初始值為 100。
query參數的offset上限為 10,000
query參數名稱的offset
如果要在查詢中搜索字串，則為單詞搜索。有關說明，請參閱以下頁面。
輸入關鍵字時的注意事項
如果使用關鍵字搜索（like， not like）作為篩選條件，則當包含該關鍵字的記錄數達到 100,000 條時，搜索將終止。
在這種情況下，在回應頭的「X-Cybozu-Warning」中會添加「Filter aborted because of too many search results」。
記錄中數據的語言由身份驗證方法確定。
- API 權杖身分驗證：管理員的顯示語言
- 其他認證方式：執行API的用戶的顯示語言
如果語言設置為「與網路瀏覽器設定相同」，則要獲取的語言將根據請求請求標頭中是否包含「Accept-Language」而變更。
請求標頭
- 帶標題：帶標頭：「Accept-Language」標頭中指定的語言
- 無標頭：在cybozu.com通用管理的地區設定中設置的語言
  地區設定
使用「GET」請求最常見的方式是「在URL中指定參數」。
其他請求方法和詳情，請參閱以下頁面。
在REST API中使用GET的三種方法及其使用方法

kintone API

kintone API文件

選取多條記錄

目錄

請求參數

回應屬性

所需存取權限

範例

補充