選取多條記錄

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

選取多條記錄

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

  • 一次最多可以選取 500 條記錄。
    可選取的記錄數在 query 參數limit中指定。
    limit的初始值為 100。
  • 參數的最大 query參數offset值為 10,000 *1
  • 如果要在查詢中搜索字串,則為單詞搜索。有關詳細資訊,請參閱 輸入搜索關鍵字的注意事項 (External link)
  • 如果搜索的查詢中有超過 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 是否檢索與中指定的條件匹配的記錄數
  • true:獲取案例數
  • false:不獲取案例數
範例請求(如果在網址中包含參數 )

將 URL 編碼的參數作為 HTTP 查詢字串發送。

URL

例如,假設您將以下參數指定為 API 的查詢字串:

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 如下所示:

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

標頭
1
2
3
{
  "X-Cybozu-API-Token": "API_TOKEN"
}

關於請求標頭,請參見 kintone REST API的通用規範

範例要求(如果要在要求內文中包含參數)
URL

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": "更新時間 > \"2012-02-03T09:00:00+0900\" and 更新時間 < \"2012-02-03T10:00:00+0900\" order by 記錄號碼 asc limit 10 offset 1",
  "fields": ["記錄編號", "建立時間", "下拉式選單"]
}

回應

屬性
屬性名稱 類型 說明
records 陣列(物件) 記錄清單
有關欄位格式,請參閱 欄位格式
totalCount 字串 新增記錄
如果為請求參數 totalCount 指定或省略“false”,則返回“null”。

示例代碼

使用 curl 的請求
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'
使用 發送kintone REST API請求的API發送的請求
1
2
3
4
5
6
7
const body = {
  app: kintone.app.getId(),
  query: '更新時間 > "2012-02-03T09:00:00+0900" and 更新時間 < "2012-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);

補充

  • 記錄中數據的語言由身份驗證方法確定。

    • API 令牌身份驗證:”Administrator”顯示語言
    • 其他認證方式:執行API的用戶的顯示語言

    如果語言設置為“遵循 Web 瀏覽器設置”,則要檢索的語言將根據 請求請求標頭 中是否包含“Accept-Language”而更改。

    • 帶標頭:”Accept-Language”標頭中指定的語言
    • 無標頭:在通用管理的 區域設置 (External link) 中設置 cybozu.com 語言