kintone API ドキュメント

（レコードの一括取得）カーソルを削除する

目次

カーソルの削除

作成したカーソルを削除します。

URL

通常のアプリ
https://sample.cybozu.com/k/v1/records/cursor.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/records/cursor.json

HTTP メソッド

DELETE

必要なアクセス権

なし

リクエスト

パラメーター
パラメーター名 型 必須 説明
id 文字列 必須 カーソル ID
リクエストの例（URLにパラメーターを含める場合）
URL

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

ヘッダー
1
2
3

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

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

リクエストの例（リクエストボディにパラメーターを含める場合）
URL

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

{}

サンプルコード

curl を使ったリクエスト
1
2
3
4
5
6

curl -X DELETE '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"
  }'
kintone REST API リクエストを送信する 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), 'DELETE', body);