カーソルを作成する
アプリに対して、レコードを一括で取得するためのカーソルを作成します。
URL
- 通常のアプリ
- https://sample.cybozu.com/k/v1/records/cursor.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/records/cursor.json
HTTP メソッド
POST
必要なアクセス権
- アプリのレコード閲覧権限
- 値を取得するレコードの閲覧権限
- 値を取得するフィールドの閲覧権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
app | 数値または文字列 | 必須 | アプリ ID |
fields | 配列(文字列) | 省略可 | レスポンスに含めるフィールドコード 省略すると、閲覧権限をもつすべてのフィールドの値が返ります。 |
query | 文字列 | 省略可 | レスポンスに含めるレコードの条件を指定するクエリ文字列 クエリ記法は、 クエリの書き方 を参照してください。 ただし、 limit と offset は指定できません。省略すると、閲覧権限をもつすべてのレコードが対象になります。 |
size | 数値または文字列 | 省略可 | 1 回の GET リクエストでカーソルから取得するレコード数 1 から 500 までの数値を指定できます。 省略すると、100 が設定されます。 |
リクエストの例
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
id | 文字列 | 作成したカーソルのカーソル ID |
totalCount | 文字列 | 取得対象となるレコード数 |
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|
制限事項
- 並行して複数のカーソルを作成できません。作成するためのリクエストが実行されている場合には、次のリクエストは待機されます。
- 有効なカーソルの数は 1 ドメインあたり 10 個までです。
上限に達した場合、次のいずれかが発生するまで新しいカーソルを作成できません。- いずれかのカーソルで、 カーソルからレコードを取得する API を実行し、すべてのレコードを取得し終えた。
- 自動的に削除される前に、 カーソルを削除する API を使ってカーソルが削除された。
- 既存のカーソルの有効期限が切れた。
- カーソルの有効期限は、カーソルを作成した、またはカーソルからレコードを取得するリクエストを実行した最終時刻から 10 分です。
- 絞り込み条件にキーワード検索(
like
,not like
)を含む場合、該当するレコードが 100,000 件に達した時点で検索を打ち切ります。
このとき、レスポンスヘッダーには"X-Cybozu-Warning" : "Filter aborted because of too many search results."
が追加されます。 - カーソルの作成は、5 分でタイムアウトします。
タイムアウトした場合、query
を単純なものに変更するか、対象となるレコードの数が少なくなるようなquery
を指定して、再実行してください。