2020年11月8日Garoon APIアップデート情報
2020年11月8日に実施するメンテナンスにおける、Garoon APIのアップデートは、次のとおりです。
Garoon JavaScript API
機能追加
メッセージの「下書きの編集/送信」画面で、メッセージの値をセットするAPIを利用できます
対象API
メッセージの値をセットする - garoon.message.body.set()
メッセージの「下書きの編集/送信」画面を表示したとき、メッセージの作成画面が表示されたときのイベントを利用できます
対象API
メッセージの作成画面を表示したときのイベント - message.body.create.show
備考
イベントオブジェクトに「下書きの編集/送信」画面か判定するdraftプロパティが追加されます。
仕様変更
先行情報でお知らせしている内容です。
2020年11月の定期メンテナンスで、予定の登録時に選択できる「公開方法」のうち「公開先を設定する」を廃止するため、次の仕様変更が入ります。
対象APIで
スケジュールオブジェクトのvisibilityType
にSET_PRIVATE_WATCHERSを指定するとエラーとなり、予定の登録または更新ができなくなります
対象API
-
予定の登録画面を表示した後のイベント -
schedule.event.create.show
-
予定を登録するときのイベント -
schedule.event.create.submit
-
予定の変更画面を表示した後のイベント
schedule.event.edit.show
-
予定を変更するときのイベント -
schedule.event.edit.submit
-
予定の詳細画面を表示した後のイベント -
schedule.event.detail.show
-
予定の値をセットする -
garoon.schedule.event.set()
対象APIで「公開方法」に「公開先を設定する」を指定した予定を操作したとき、
スケジュールオブジェクトのvisibilityType
の値が「PRIVATE」になります
対象API
-
予定を登録するときのイベント -
schedule.event.create.submit
-
予定を登録するときのイベント -
schedule.event.create.submit
-
予定の変更画面を表示した後のイベント
schedule.event.edit.show
-
予定を変更するときのイベント -
schedule.event.edit.submit
-
予定の詳細画面を表示した後のイベント -
schedule.event.detail.show
-
予定の値を取得する -
garoon.schedule.event.get()
修正内容
「公開方法」に「公開先を設定する」を指定した予定について、 スケジュールオブジェクトのvisibilityTypeの値が次のとおり変わります。
- 修正前
- SET_PRIVATE_WATCHERSが返却される。
- 修正後
- PRIVATEが返却される。
Garoon REST API
仕様変更
先行情報でお知らせしている内容です。
2020年11月の定期メンテナンスで、予定の登録時に選択できる「公開方法(visibilityType)」のうち「公開先を設定する」を廃止するため、次の仕様変更が入ります。
対象APIで
スケジュールオブジェクトのvisibilityType
にSET_PRIVATE_WATCHERSを指定するとエラーとなり、予定の登録または更新ができなくなります
対象API
「公開方法」の値がいかなる場合でも、対象APIでwatchers
プロパティを指定できます
対象API
対象APIで、「公開方法」に「公開先を設定する」を指定した予定を取得したとき、
スケジュールオブジェクトのvisibilityType
の値が「PRIVATE」になります
対象API
修正内容
「公開方法」に「公開先を設定する」を指定した予定について、 スケジュールオブジェクトのvisibilityTypeの値が次のとおり変わります。
- 修正前
- SET_PRIVATE_WATCHERSで返却される。
- 修正後
- PRIVATEで返却される。
対象APIで共有先を設定した予定を取得したとき、「公開方法」の値がいかなる場合でもwatchersプロパティを取得できます
対象API
-
1件の予定を取得する -
/g/api/v1/schedule/events/{id}
[GET] -
複数の予定を取得する -
/g/api/v1/schedule/events
[GET]
備考
- APIを実行したユーザーが参加または共有されていない非公開の予定は、従来どおり404エラーとなり取得できません。
Garoon SOAP API
仕様変更
先行情報でお知らせしている内容です。
2020年11月の定期メンテナンスで、予定の登録時に選択できる「公開方法(@public_type)」のうち「公開先を設定する」を廃止するため、次の仕様変更が入ります。
対象APIで
schedule:EventTypeの@public_type
にqualifiedを指定するとエラーとなり、予定の登録または更新ができなくなります
対象API
-
予定を登録する -
ScheduleAddEvents
-
予定を変更する -
ScheduleModifyEvents
-
繰り返し予定を変更する -
ScheduleModifyRepeatEvents
「公開方法」の値がいかなる場合でも、対象APIでobserversプロパティを指定できます
対象API
-
予定を登録する -
ScheduleAddEvents
-
予定を変更する -
ScheduleModifyEvents
-
繰り返し予定を変更する -
ScheduleModifyRepeatEvents
対象APIで「公開方法」に「公開先を設定する」を指定した予定を操作したとき、
schedule:EventTypeの@public_type
の値が「private」になります
対象API
-
予定に参加する -
ScheduleParticipateEvents
-
予定から抜ける -
ScheduleLeaveEvents
-
予定を検索する -
ScheduleSearchEvents
-
繰り返し予定に参加する -
ScheduleParticipateEventsToRepeatEvent
-
繰り返し予定から抜ける -
ScheduleLeaveEventsFromRepeatEvent
-
仮予定を確定する -
ScheduleDetermineTemporaryEvents
-
予定にコメントを追加する -
ScheduleAddFollows
-
繰り返し予定にコメントを追加する -
ScheduleAddFollowsToRepeatEvent
-
指定した期間の予定を取得する -
ScheduleGetEvents
-
指定したIDの予定を取得する -
ScheduleGetEventsById
-
指定したユーザー、組織、または施設の予定を取得する -
ScheduleGetEventsByTarget
-
予定を登録する -
ScheduleAddEvents
-
予定を変更する -
ScheduleModifyEvents
-
繰り返し予定を変更する -
ScheduleModifyRepeatEvents
修正内容
「公開方法」に「公開先を設定する」を指定した予定について、
schedule:EventTypeの@public_type
の値が次のとおり変わります。
- 修正前
- qualifiedで返却される。
- 修正後
- privateで返却される。
対象APIで共有先を設定した予定を操作したとき、「公開方法」に設定した値がいかなる場合でもobservers
プロパティを取得できます
対象API
-
予定に参加する -
ScheduleParticipateEvents
-
予定から抜ける -
ScheduleLeaveEvents
-
予定を検索する -
ScheduleSearchEvents
-
繰り返し予定に参加する -
ScheduleParticipateEventsToRepeatEvent
-
繰り返し予定から抜ける -
ScheduleLeaveEventsFromRepeatEvent
-
仮予定を確定する -
ScheduleDetermineTemporaryEvents
-
予定にコメントを追加する -
ScheduleAddFollows
-
繰り返し予定にコメントを追加する -
ScheduleAddFollowsToRepeatEvent
-
指定した期間の予定を取得する -
ScheduleGetEvents
-
指定したIDの予定を取得する -
ScheduleGetEventsById
-
指定したユーザー、組織、または施設の予定を取得する -
ScheduleGetEventsByTarget
-
予定を登録する -
ScheduleAddEvents
-
予定を変更する -
ScheduleModifyEvents
-
繰り返し予定を変更する -
ScheduleModifyRepeatEvents
備考
APIを実行したユーザーが参加または共有されていない非公開の予定は、従来どおり404エラーとなり取得できません。
対象APIで予定を登録した場合、予定を共有されたユーザーへ通知される予定タイトルの先頭に「[共有]」が付与されます
対象API
-
通知を取得する -
NotificationGetNotificationsById
-
確認済み通知を取得する -
NotificationGetNotificationHistoriesById
-
通知を確認済みにする -
NotificationConfirmNotification
備考
「[共有]」が付与される通知は、次のいずれかの条件に当てはまる場合です。
- 予定の共有先にのみ「ログインユーザー」「所属組織」「所属ロール」が指定されている。
- 出欠確認で欠席を選択していて、予定の共有先に「ログインユーザー」「所属組織」「所属ロール」が指定されている。
製品のアップデート情報
API以外のGaroonのアップデートに関する情報は、
クラウド版Garoon更新情報
を参照してください。
11月定期メンテナンス分は後日公開されます。