2020年11月の定期メンテナンスにおけるGaroonの仕様変更に関する情報を一部先行してお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメントにて変更箇所を追記します。
Garoon
仕様変更
公開設定のタイプ(SET_PRIVATE_WATCHERS および qualified)の廃止
2020年11月の定期メンテナンスにおいて、予定を共有する機能をリリース予定です。
予定に参加するユーザー以外にも予定があることをお知らせすることができる機能です。
これに伴い、2020年11月の定期メンテナンスにおいて、予定登録時に選択できる「公開方法」のうち、「公開先を設定する」を廃止いたします。
この定期メンテナンスにより、以下に挙げる「公開設定」に関するプロパティの一部の値を廃止いたします。
- スケジュールの event オブジェクトにおける visibilityType の SET_PRIVATE_WATCHERS
- schedule:EventType における @public_type の qualified
対象API
- Garoon REST API
- 予定の取得(GET) /g/api/v1/schedule/events
- 予定の登録(POST) /g/api/v1/schedule/events
- 予定の更新(PATCH) /g/api/v1/schedule/events
- Garoon JavaScript API
- 予定の登録画面が表示されたときのイベント schedule.event.create.show
- 予定の登録画面の保存実行前イベント schedule.event.create.submit
- 予定の変更画面が表示されたときのイベント schedule.event.edit.show
- 予定の変更画面の保存実行前イベント schedule.event.edit.submit
- 予定の詳細画面が表示されたときのイベント schedule.event.detail.show
- 予定の値を取得する garoon.schedule.event.get()
- 予定の値をセットする garoon.schedule.event.set()
- Garoon SOAP API
- 予定を検索する ScheduleSearchEvents
- 指定した期間の予定を取得する ScheduleGetEvents
- 指定した ID の予定を取得する ScheduleGetEventsById
- 指定したユーザー、組織、または施設の予定を取得する ScheduleGetEventsByTarget
- 予定を登録する ScheduleAddEvents
- 予定を変更する ScheduleModifyEvents
- 繰り返し予定を変更する ScheduleModifyRepeatEvents
- 予定に参加する ScheduleParticipateEvents
- 予定から抜ける ScheduleLeaveEvents
- 繰り返し予定に参加する ScheduleParticipateEventsToRepeatEvent
- 繰り返し予定から抜ける ScheduleLeaveEventsFromRepeatEvent
- 仮予定を確定する ScheduleDetermineTemporaryEvents
- 予定にコメントを追加する ScheduleAddFollows
- 繰り返し予定にコメントを追加する ScheduleAddFollowsToRepeatEvent
修正内容
- Garoon REST API / JavaScript API
- スケジュールの event オブジェクトの visibilityType において SET_PRIVATE_WATCHERS を指定するとエラーが返却され、予定の登録/更新ができなくなります。
- スケジュールの event オブジェクトがレスポンスに含まれる API については、visibilityType の値として 公開先設定(SET_PRIVATE_WATCHERS) が返却されなくなり、非公開(PRIVATE)が返却されます。
- Garoon SOAP API
- schedule:EventType における @public_type で qualified を指定するとエラーが返却され、予定の登録/更新ができなくなります。
- schedule:EventType がレスポンスに含まれる SOAP API については、@public_type の値として 公開先設定(qualified)が返却されなくなり、非公開(private)が返却されます。
11月定期メンテナンス以前に登録された予定について
2020年11月定期メンテナンス以前に登録された予定において、「公開方法」を「公開先を設定する」で登録した予定は以下のようになります。
- 「公開方法」は「非公開」になります。
- 「公開先を設定する」で設定していた公開先のユーザー情報は、予定を共有する機能(11月リリース予定)における、共有先のユーザー情報に設定されます。
2020/8/4 修正:
仕様変更の影響を受ける Garoon SOAP API について、記載漏れ、API 名に誤りがあったため修正いたしました。
修正内容は以下の通りです。
【追記した Garoon SOAP API】
【修正した Garoon SOAP API】
誤:ScheduleGetEventVersions
正:ScheduleGetEvents