2020年11月8日 Garoon API アップデート情報

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
対象 API で「公開方法」に「公開先を設定する」を指定した予定を操作したとき、 スケジュールオブジェクトvisibilityType の値が「PRIVATE」になります
対象 API
修正内容

「公開方法」に「公開先を設定する」を指定した予定について、 スケジュールオブジェクト の 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
備考
  • API を実行したユーザーが参加または共有されていない非公開の予定は、従来どおり 404 エラーとなり取得できません。

Garoon SOAP API

仕様変更

先行情報 でお知らせしている内容です。
2020 年 11 月の定期メンテナンスで、予定の登録時に選択できる「公開方法(@public_type)」のうち「公開先を設定する」を廃止するため、次の仕様変更が入ります。

対象 API で schedule:EventType@public_type に qualified を指定するとエラーとなり、予定の登録または更新ができなくなります
対象 API
「公開方法」の値がいかなる場合でも、対象 API で observers プロパティを指定できます
対象 API
対象 API で「公開方法」に「公開先を設定する」を指定した予定を操作したとき、 schedule:EventType@public_type の値が「private」になります
対象 API
修正内容

「公開方法」に「公開先を設定する」を指定した予定について、 schedule:EventType@public_type の値が次のとおり変わります。

修正前
qualified で返却される。
修正後
private で返却される。
対象 API で共有先を設定した予定を操作したとき、「公開方法」に設定した値がいかなる場合でも observers プロパティを取得できます
対象 API
備考

API を実行したユーザーが参加または共有されていない非公開の予定は、従来どおり 404 エラーとなり取得できません。

対象 API で予定を登録した場合、予定を共有されたユーザーへ通知される予定タイトルの先頭に「[共有]」が付与されます
対象 API
備考

「[共有]」が付与される通知は、次のいずれかの条件に当てはまる場合です。

  • 予定の共有先にのみ「ログインユーザー」「所属組織」「所属ロール」が指定されている。
  • 出欠確認で欠席を選択していて、予定の共有先に「ログインユーザー」「所属組織」「所属ロール」が指定されている。

製品のアップデート情報

API 以外の Garoon のアップデートに関する情報は、 クラウド版 Garoon 更新情報 (External link) を参照してください。
11 月定期メンテナンス分は後日公開されます。