【重要】2020年11月の定期メンテナンスにおけるGaroonに関する仕様変更について
API更新情報
2020年11月の定期メンテナンスにおけるGaroonの仕様変更に関する情報を一部先行してお知らせします。 お知らせの内容に追加、変更等ありましたら、こちらのコメントにて変更箇所を追記します。
公開設定のタイプ(「SET_PRIVATE_WATCHERS」および「qualified」)を廃止します
2020年11月の定期メンテナンスにおいて、予定を共有する機能をリリース予定です。
予定に参加するユーザー以外にも予定があることをお知らせできる機能です。
これに伴い、2020年11月の定期メンテナンスにおいて、予定登録時に選択できる「公開方法」のうち、「公開先を設定する」を廃止します。
この定期メンテナンスにより、以下に挙げる「公開設定」に関するプロパティの一部の値を廃止します。
-
スケジュールオブジェクトにおける
visibilityType
の「SET_PRIVATE_WATCHERS」 -
schedule:EventTypeにおける
@public_type
の「qualified」
対象API
Garoon REST API
-
複数の予定を取得する -
/g/api/v1/schedule/events
[GET] -
予定を登録する -
/g/api/v1/schedule/events
[POST] -
予定を更新する -
/g/api/v1/schedule/events
[PATCH]
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
- スケジュールのイベントオブジェクトの
visibilityType
において「SET_PRIVATE_WATCHERS」を指定するとエラーが返却され、予定の登録/更新ができなくなります。 - スケジュールのイベントオブジェクトがレスポンスに含まれる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月リリース予定)における、共有先のユーザー情報に設定されます。