Garoon APIドキュメント

予定を削除する

目次

予定を削除する

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

予定を削除します。

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

URL

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

クラウド版

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

パッケージ版

環境に合わせてそれぞれ以下を置き換えてください。

  • IP_ADDRESS_OR_HOST_NAME：Garoonのインストール先のIPアドレスまたはホスト名
  • INSTALL_IDENTIFER：Garoonのインストール識別子
Windows環境
http://IP_ADDRESS_OR_HOST_NAME/scripts/INSTALL_IDENTIFER/grn.exe/api/v1/schedule/events/SCHEDULE_ID
Linux環境
http://IP_ADDRESS_OR_HOST_NAME/cgi-bin/INSTALL_IDENTIFER/grn.cgi/api/v1/schedule/events/SCHEDULE_ID
パスパラメーター
パラメーター名 型 必須 説明
SCHEDULE_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', {});