kintone API

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

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

目次

HTTPメソッドDELETE
URLhttps://sample.cybozu.com/k/v1/records/cursor.json
URL(ゲストスペース)https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/records/cursor.json
認証 パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Typeapplication/json(URLにパラメーターを含める場合は不要)

リクエストパラメーター

パラメーター名 必須 説明
id 文字列 必須 カーソルID

レスポンスプロパティ

なし

必要なアクセス権

なし

サンプル

1
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の共通仕様

1
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
{}

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);

ご利用の環境によって、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"
  }'