Garoon API ドキュメント

予定を削除する

目次

予定を削除する

予定を削除します。

  • 繰り返し予定の ID を指定すると、すべての範囲の予定が削除されます。
  • 仮予定は削除できません。

URL

クラウド版

https://sample.cybozu.com/g/api/v1/schedule/events/予定 ID

パッケージ版
Windows 環境
http://サーバーの IP アドレスまたはホスト名/scripts/インストール識別子/grn.exe/api/v1/schedule/events/予定 ID
Linux 環境
http://サーバーの IP アドレスまたはホスト名/cgi-bin/インストール識別子/grn.cgi/api/v1/schedule/events/予定 ID
パスパラメーター
パラメーター名 型 必須 説明
予定 ID 数値 必須 削除する予定の予定 ID

HTTP メソッド

DELETE

利用できるバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 4.10 以降

必要なアクセス権

  • 予定の削除権限

リクエスト

パラメーター

なし

リクエストの例
URL

https://sample.cybozu.com/g/api/v1/schedule/events/1

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

レスポンス

なし

サンプルコード

curl を使ったリクエスト
1
2

curl -X DELETE 'https://sample.cybozu.com/g/api/v1/schedule/events/1' \
  -H 'X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST API リクエストを送信する API を使ったリクエスト
1

await garoon.api('/api/v1/schedule/events/1', 'DELETE', {});