建立游標
為應用創建遊標以批量獲取記錄。
URL
- 常規應用程式
- https://sample.cybozu.com/k/v1/records/cursor.json
- 訪客空間的應用程式
- https://sample.cybozu.com/k/guest/
GUEST_SPACE_ID
/v1/records/cursor.json
HTTP 方法
POST
存取權限
- 查看應用程式中記錄的許可權
- 查看要選取其值的記錄的許可權
- 查看要選取其值的欄位的許可權
請求
參數
參數名稱 | 類型 | 必須 | 說明 |
---|---|---|---|
app | 數值或字串 | 必須 | 應用ID |
fields | 陣列(字串) | 可省略 | 要包含在回應中的域代碼 如果省略,則返回您有權查看的所有欄位的值。 |
query | 字串 | 可省略 | 一個查詢字串,用於指定要包含在回應中的記錄的條件 有關查詢表示法的詳細資訊,請參閱以下頁面。 如何編寫查詢 但是, limit 不能指定 和 offset 。如果省略,則包括您有權查看的所有記錄。 |
size | 數值或字串 | 可省略 | 要在單個 GET 請求中從遊標獲取的記錄數 您可以指定一個介於 100 和 500 之間的數值。 如果省略,則設置為100。 |
示例請求
標頭
|
|
有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規範
內文
|
|
回應
屬性
屬性名稱 | 類型 | 說明 |
---|---|---|
id | 字串 | 您建立的游標的游標 ID |
totalCount | 字串 | 要獲取的記錄數 |
示例回應
|
|
示例代碼
使用 curl 的請求
|
|
kintone.api()
請求使用
有關詳細的kintone.api()
,請參閱以下頁面。
發送kintone REST API請求
|
|
限制
- 不能並行創建多個遊標。如果正在執行創建請求,則將等待下一個請求。
- 每個域的有效遊標數限制為10個。
當達到限制時,在發生下列情況之一之前,不能創建新的遊標:- 在其中一個游標中,您已執行以從游標中獲取記錄API,並已完成獲取所有記錄。
從游標中選取記錄API - 游標在自動刪除之前已使用用於刪除遊標的API刪除。
用於刪除遊標的 API - 現有游標已過期。
- 在其中一個游標中,您已執行以從游標中獲取記錄API,並已完成獲取所有記錄。
- 游標過期時間為上次創建遊標或請求從遊標獲取記錄起 10 分鐘。
- 如果在精簡程式中包含關鍵字搜索 (
like
,not like
),則當相關記錄數達到 100,000 條時,搜索將終止。
在本例中,將添加到"X-Cybozu-Warning" : "Filter aborted because of too many search results."
響應標頭中。 - 游標的創建將在 5 分鐘後超時。
如果超時,query
請變更為更簡單的內容,或指定可減少query
所涉及的記錄數的內容,然後重試。