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

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

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

リクエストパラメーター

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

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

レスポンスプロパティ

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

なし

必要なアクセス権

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

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

サンプル

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

サンプルリクエスト

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

1

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

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


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

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

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

1

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

{}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST 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);

curlを使ったリクエスト

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

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]
  }'

補足

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

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

kintone API

kintone APIドキュメント

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

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足