kintone API ドキュメント

複数のレコードを削除する

目次

複数のレコードを削除する

複数のレコードを削除します。

  • 一度に削除できるレコードは 100 件までです。
  • 処理に失敗すると、リクエストに指定したレコードの削除はすべてキャンセルされます。

URL

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

HTTP メソッド

DELETE

必要なアクセス権

  • アプリのレコード削除権限
  • 値を削除するレコードの削除権限

リクエスト

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリ ID
ids 配列（数値） 必須 削除するレコードのレコード ID の一覧
revisions 配列（数値） 省略可 期待しているリビジョン番号
実際のリビジョン番号と一致しない場合はエラーとなり、レコードは削除されません。
値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。
リクエストの例（URLにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/records.json?app=8&ids[0]=100&ids[1]=80&revisions[0]=1&revisions[1]=4

ヘッダー
1
2
3

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

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

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

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

ヘッダー
1
2
3
4

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

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

ボディ
1
2
3
4
5

{
  "app": 1,
  "ids": [100, 80],
  "revisions": [1, 4]
}

レスポンス

1

{}

サンプルコード

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

curl -X DELETE 'https://sample.cybozu.com/k/v1/records.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "ids": [100, 80],
    "revisions": [1, 4]
  }'
kintone REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5
6
7

const body = {
  app: 1,
  ids: [100, 80],
  revisions: [1, 4]
};

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