予定の更新(1件)
予定 ID を指定して予定の内容を更新できます。
- 繰り返し予定の場合、元の予定を更新します。
- 仮予定は更新できません。
HTTP メソッド
PATCH
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/schedule/events/{id}
パッケージ版(Windows 環境)
以下は、ヘルプに記載している Windows のディレクトリー構成 でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/schedule/events/{id}
パッケージ版(Linux 環境)
以下は、ヘルプに記載している Linux のディレクトリー構成 でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/schedule/events/{id}
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 4.10.0 以降
必要なアクセス権
予定の変更権限
リクエストの例
リクエストヘッダ
PATCH /g/api/v1/schedule/events/1 HTTP/1.1 Host: {subdomain}.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
- Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
リクエストボディ
※各フィールドの形式については スケジュールの event オブジェクト をご確認ください。
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
eventMenu | 文字列 | 省略可 | 予定メニュー 予定メニューのデフォルト設定値「-----」の value は空文字列とみなされます。詳細 |
subject | 文字列 | 省略可 | タイトル |
notes | 文字列 | 省略可 | メモ 改行文字は「\n」です。 |
start | オブジェクト | 必須 | 開始日時とタイムゾーン |
start.dateTime | 文字列 | 必須 | 予定の開始日時 形式は RFC3339 です。 |
start.timeZone | 文字列 | 必須 | 開始日時のタイムゾーン |
end | オブジェクト | 条件必須 | 終了日時とタイムゾーン 次にあてはまる場合、必須です。
|
end.dateTime | 文字列 | 条件必須 | 予定の終了日時 形式は RFC3339 です。 |
end.timeZone | 文字列 | 条件必須 | 終了日時のタイムゾーン |
isAllDay | 真偽値 | 省略可 | 終日の予定かどうか |
isStartOnly | 真偽値 | 条件必須 | 開始のみの予定かどうか ※ 省略した場合のデフォルト値は false です。 ※ end を省略する場合は、isStartOnly の値に true を指定してください。 |
attendees | 配列 | 条件必須 | 参加者のリスト ※ attendees(参加者)または facilities(施設)のいずれかが必須です。 ※ 未指定で更新すると、空配列で上書きされます。更新前の attendees を残す場合は、必ず値を指定してください。 |
attendees[].type | 参加者のタイプ 次のいずれかの値を指定します。
|
||
attendees[].id | 文字列 | 条件必須 | attendees[].type に指定する値により異なります。
|
attendees[].code | 文字列 | 条件必須 | attendees[].type に指定する値により異なります。
※ id と code を指定すると、id の値が優先されます。 |
facilities | 配列 | 条件必須 | 施設のリスト ※ attendees(参加者)または facilities(施設)のいずれかが必須です。 ※ 未指定で更新すると、空配列で上書きされます。更新前の facilities を残す場合は、必ず値を指定してください。 |
facilities[].id | 文字列 | 条件必須 | 施設名 ID ※ facilities を指定する場合、id または code が必須です。 |
facilities[].code | 文字列 | 条件必須 | 施設の候補リストの施設コード ※ facilities を指定する場合、id または code が必須です。 ※ id と code を指定すると、id の値が優先されます。 |
facilityUsingPurpose | 文字列 | 条件必須 | 施設の利用目的 ※「施設の利用申請」を有効にした場合、必須です。 |
companyInfo | オブジェクト | 省略可 | 会社情報 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
companyInfo.name | 文字列 | 省略可 | 会社名 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
companyInfo.zipCode | 文字列 | 省略可 | 郵便番号 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
companyInfo.address | 文字列 | 省略可 | 住所 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
companyInfo.route | 文字列 | 省略可 | 路線の経路 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
companyInfo.routeTime | 文字列 | 省略可 | 路線の所要時間 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
companyInfo.routeFare | 文字列 | 省略可 | 路線の運賃 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
companyInfo.phone | 文字列 | 省略可 | 電話番号 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
attachments | 配列 | 省略可 | 添付ファイルのリスト システム設定で「ファイルの添付」の許可が必要です。 |
attachments[].name | 文字列 | 省略可 | 添付ファイルのファイル名 |
attachments[].content | 文字列 | 省略可 | 添付ファイルの内容 Base エンコードが必要です。 |
visibilityType | 文字列 | 省略可 |
公開設定のタイプ 次のいずれかの値を指定します。
※ パッケージ版 Garoon バージョン 5.0.0〜5.5.1 でのみ指定可能 |
useAttendanceCheck | 真偽値 | 省略可 |
出欠確認を使用しているかどうか システム設定で「出欠確認の使用」の許可が必要です。 |
watchers | 配列 | 条件必須 |
共有先のリスト ※ visibilityType が SET_PRIVATE_WATCHERSの場合、必須です。 ※ 未指定で更新すると、空配列で上書きされます。更新前の watchers を残す場合は、必ず値を指定してください。 |
watchers[].type | 文字列 | 条件必須 |
共有先のタイプ 次のいずれかの値を指定します。
※ watches を指定する場合、必須です。 |
watchers[].id | 文字列 | 条件必須 |
watchers[].type に指定した値により異なります。
※ watches を指定する場合、id または code が必須です。 |
watchers[].code | 文字列 | 条件必須 |
watchers[].type に指定した値により異なります。
※ id と code を指定すると、id の値が優先されます。 ※ クラウド版とパッケージ版 Garoon バージョン 5.0.0以降で指定可能 |
additionalItems | オブジェクト | 省略可 | 予定の API 用連携項目 |
additionalItems.item.value | 文字列 | 省略可 | 予定の API 用連携項目の値 |
レスポンスの例
処理が成功すると、予定の内容がJSON形式で返されます。※各フィールドの形式については スケジュールの event オブジェクトをご確認ください。
JavaScript サンプル
XMLHttpRequest
制限事項
- API を使ってアップロードできるファイルサイズは、BASE64 エンコード後で 300MB までです。
その他の制限事項は、共通仕様の制限事項 をご確認ください。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。