kintone APIドキュメント

レコードコメントを削除する

目次

レコードコメントを削除する

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

レコードのコメントを削除します。

  • APIを実行するユーザーが投稿したコメントのみ、削除できます。
    • APIトークン認証でAPIを実行する場合には、「Administrator」ユーザーが投稿したコメントだけを削除できます。
  • レコードのコメント機能を無効にしたアプリで実行すると、エラーになります。

URL

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

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

HTTPメソッド

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

DELETE

必要なアクセス権

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

  • コメントを削除するアプリの閲覧権限
  • コメントを削除するレコードの閲覧権限

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
app 数値または文字列 必須 アプリID
record 数値または文字列 必須 レコードID
comment 数値または文字列 必須 コメントID
リクエストの例 （URLにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/record/comment.json?app=1&record=1&comment=1

ヘッダー
1
2
3

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

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

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

https://sample.cybozu.com/k/v1/record/comment.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,
  "record": 1,
  "comment": 1
}

レスポンス

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

プロパティ

なし

レスポンスの例
1

{}

サンプルコード

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

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

curl -X DELETE 'https://sample.cybozu.com/k/v1/record/comment.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "record": 1001,
    "comment": 1
  }'
kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する 

1
2
3
4
5
6
7

const body = {
  app: kintone.app.getId(),
  record: 1001,
  comment: 1
};

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