kintone APIドキュメント

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

目次

カーソルの削除

固定リンクがコピーされました

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

URL

固定リンクがコピーされました

通常のアプリ
https://sample.cybozu.com/k/v1/records/cursor.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_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を使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行 

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.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), 'DELETE', body);