カーソルを作成する

アプリに対して、レコードを一括で取得するためのカーソルを作成します。

URL

通常のアプリ

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

ゲストスペースのアプリ

https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/records/cursor.json

HTTP メソッド

POST

必要なアクセス権

• アプリのレコード閲覧権限
• 値を取得するレコードの閲覧権限
• 値を取得するフィールドの閲覧権限

リクエスト

パラメーター

リクエストの例

ヘッダー

1
2
3
4

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

リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。

ボディ

1
2
3
4
5
6

{
  "app": 1,
  "fields": ["レコード番号", "作成者", "作成日時"],
  "query": "作成者 in (LOGINUSER()) and 作成日時 = TODAY() order by レコード番号 asc",
  "size": 500
}

レスポンス

プロパティ

レスポンスの例

1
2
3
4

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

サンプルコード

curl を使ったリクエスト

1
2
3
4
5
6
7
8
9

curl -X POST 'https://sample.cybozu.com/k/v1/records/cursor.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "fields": ["レコード番号", "作成者", "作成日時"],
    "query": "作成者 in (LOGINUSER()) and 作成日時 = TODAY() order by レコード番号 asc",
    "size": 500
  }'

kintone REST API リクエストを送信する API を使ったリクエスト

1
2
3
4
5
6
7
8

const body = {
  app: kintone.app.getId(),
  fields: ['レコード番号', '作成者', '作成日時'],
  query: '作成者 in (LOGINUSER()) and 作成日時 = TODAY() order by レコード番号 asc',
  size: 500
};

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

制限事項

• 並行して複数のカーソルを作成できません。作成するためのリクエストが実行されている場合には、次のリクエストは待機されます。
• 有効なカーソルの数は 1 ドメインあたり 10 個までです。
  上限に達した場合、次のいずれかが発生するまで新しいカーソルを作成できません。
  • いずれかのカーソルで、 カーソルからレコードを取得する API を実行し、すべてのレコードを取得し終えた。
  • 自動的に削除される前に、 カーソルを削除する API を使ってカーソルが削除された。
  • 既存のカーソルの有効期限が切れた。
• カーソルの有効期限は、カーソルを作成した、またはカーソルからレコードを取得するリクエストを実行した最終時刻から 10 分です。
• 絞り込み条件にキーワード検索（like, not like）を含む場合、該当するレコードが 100,000 件に達した時点で検索を打ち切ります。
  このとき、レスポンスヘッダーには "X-Cybozu-Warning" : "Filter aborted because of too many search results." が追加されます。
• カーソルの作成は、5 分でタイムアウトします。
  タイムアウトした場合、query を単純なものに変更するか、対象となるレコードの数が少なくなるような query を指定して、再実行してください。