Delete Cursor

Deletes a cursor by specifying the cursor ID.

MethodDELETE
URLhttps://{subdomain}.kintone.com/k/v1/records/cursor.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/records/cursor.json
Authentication Password Authentication , API Token Authentication , Session Authentication
Content-Typeapplication/json

Contents

Request Parameters

Parameter Value Required Description
id String Yes The cursor ID.

Sample Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
var body = {
  'id': '9a9716fe-1394-4677-a1c7-2199a5d28215'
};
kintone.api(kintone.api.url('/k/v1/records/cursor.json', true), 'DELETE', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

curl Sample

1
2
3
4
curl -X DELETE 'https://{subdomain}.kintone.com/k/v1/records/cursor.json' \
  -H 'X-Cybozu-API-Token: {APIToken}' \
  -H 'Content-Type: application/json' \
  -d '{"id": "9a9716fe-1394-4677-a1c7-2199a5d28215"}'

Sample Response

1
{}