（大量獲取記錄）從游標中取得記錄

kintone API

（大量獲取記錄）從游標中取得記錄

連結已複製

從游標中選取記錄。

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

請求參數

連結已複製

參數名稱	類型	必須	說明
id	字串	必須	游標ID

應答屬性

連結已複製

屬性名稱	類型	說明
records	陣列	記錄清單有關欄位格式，請參閱以下頁面。欄位格式
next	布爾值	是否有以下記錄： `true`：有記錄 `false`：暫無記錄

所需存取權限

連結已複製

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

範例

連結已複製

請求範例

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

1

https://sample.cybozu.com/k/v1/records/cursor.json?id=9a9716fe-1394-4677-a1c7-2199a5d28215

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

1
2
3


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

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

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

1

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

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

1
2
3
4


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

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

請求主體

1
2
3


{
  "id": "9a9716fe-1394-4677-a1c7-2199a5d28215"
}

範例回應

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22


{
  "records": [
    {
      "記錄號碼": {
        "type": "RECORD_NUMBER",
        "value": "1"
      },
      "建立人": {
        "type": "CREATOR",
        "value": {
          "code": "Administrator",
          "name": "Administrator"
        }
      },
      "建立時間": {
        "type": "CREATED_TIME",
        "value": "2025-05-23T04:50:00Z"
      }
    }
  ],
  "next": false
}

範例程式碼

使用kintone.api()傳送請求

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

1
2
3
4
5


const body = {
  id: '9a9716fe-1394-4677-a1c7-2199a5d28215'
};

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

使用curl傳送請求

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

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/records/cursor.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "9a9716fe-1394-4677-a1c7-2199a5d28215"
  }'

補充

連結已複製

記錄中數據的語言由身份驗證方法確定。
- API 權杖身分驗證：管理員的顯示語言
- 其他認證方式：執行API的用戶的顯示語言
如果語言設置為「與網路瀏覽器設定相同」，則要獲取的語言將根據請求請求標頭中是否包含「Accept-Language」而變更。
請求標頭
- 帶標題：帶標頭：「Accept-Language」標頭中指定的語言
- 無標頭：在cybozu.com通用管理的地區設定中設置的語言
  地區設定
「GET」請求最常見的方式是「在URL中指定參數」。
其他請求方法及詳情，請參閱以下頁面。
在 REST API 中使用 GET 的三種方法及其使用方法

限制事項

連結已複製

可以從遊標中獲取的記錄是在創建遊標時獲取到的記錄。
但是，在執行此 API 時將返回該欄位的值。
如果在創建遊標后變更了存取權限的設置，則變更的設置可能會獲取到不應滿足過濾條件的記錄。
但是，您無法獲取您無權查看的欄位的值。
如果在創建遊標后變更運行 API 的用戶的語言設置，則多語言欄位將受到影響。
獲取到可從游標中獲取的所有記錄后，將自動刪除該遊標。
在回應中即使next變為true，下一個請求的records可能會返回空。

kintone API

kintone API文件

（大量獲取記錄）從游標中取得記錄

目錄

請求參數

應答屬性

所需存取權限

範例

補充

限制事項