2021年11月14日 Garoon API アップデート情報

API 更新情報

2021 年 11 月 14 日に実施するメンテナンスにおける、Garoon API のアップデート内容は次のとおりです。

Garoon REST API

機能追加

スケジュールで、管理者が予定の施設を取得、登録、変更および削除できる API を追加しました
対象 API
スケジュールで、管理者が予定の施設グループを取得、登録、変更および削除できる API を追加しました
対象 API
プラグインを利用しているかどうかや、利用する対象を取得できる API を追加しました
対象 API

プラグインの基本設定を取得する - /g/api/v1/system/plugin/admin/settings/{pluginId} [GET]

不具合修正

スケジュールで、cybozu.com から削除されたユーザーのみが参加する予定を取得できる現象を解消しました

2021 年 11 月 26 日追記:この修正の対応は、延期されました。
2021 年 11 月メンテナンスにおける Garoon REST API および SOAP API 不具合修正の一部切り戻し

対象 API

1 件の予定を取得する - /g/api/v1/schedule/events/{id} [GET]

修正内容

取得できる予定のデータは、次のとおり。

修正前
指定した ID の予定データが返る。
修正後
GRN_SCHD_13001 エラーが発生する。
ワークフローで、項目コードの値が 0 からの連番になっている場合に、項目コードが配列で返されることがある現象を解消しました
対象 API

申請データを取得する - /g/api/v1/workflow/admin/requests [GET]

発生条件

項目コード(items)の値が、「0」「1」「2」のように、0 からの連番になっている。

修正内容

取得できる申請データの項目コード(items)は、次のとおりです。

修正前
配列が返る。
修正後
オブジェクトが返る。

Garoon JavaScript API

機能追加

ワークフローで、申請の提出が成功したときのイベントを追加しました
対象イベント

ワークフロー申請を提出したときのイベント - workflow.request.create.submit.success

備考

「申請の作成(内容の確認)」画面で、[申請する]をクリックして成功したときに発生するイベントです。
再利用または下書きから申請したときには、このイベントは発生しません。

ワークフローで、申請の確認が成功したときのイベントを追加しました
対象イベント

ワークフロー申請を確認したときのイベント - workflow.request.acknowledge.submit.success

備考

「未処理申請の処理」画面で、[確認する]をクリックし成功したときに発生するイベントです。

ワークフローで、申請フォームの ID を取得できるようになりました
対象イベント

すべてのワークフローのイベント

スケジュールで、予定への参加が成功したときのイベントを追加しました
対象イベント

予定の参加に成功したときのイベント - schedule.event.attend.submit.success

備考

「予定への参加」画面で、[はい]をクリックして、成功したときに発生するイベントです。

スケジュールで、予定の参加者から抜けることに成功したときのイベントを追加しました
対象イベント

予定から抜けることに成功したときのイベント - schedule.event.leave.submit.success

備考

「予定から抜ける」画面で、[はい]をクリックして、成功したときに発生するイベントです。

不具合修正

ワークフロー申請が承認されたときのイベントで、決裁番号を取得できない現象を解消しました
対象イベント

ワークフロー申請を承認したときのイベント - workflow.request.approve.submit.success

発生条件

申請データのフォームに決裁番号を設定している。

修正内容

申請データの申請番号(number)の値が、次のように修正されます。

修正前
申請番号
修正後
決裁番号

Garoon SOAP API

不具合修正

スケジュールで、cybozu.com から削除されたユーザーのみが参加する予定を取得できる現象を解消しました

2021 年 11 月 26 日追記:この修正の対応は、延期されました。
参考: 2021 年 11 月メンテナンスにおける Garoon REST API および SOAP API 不具合修正の一部切り戻し

対象 API

指定した ID の予定を取得する - ScheduleGetEventsById

修正内容

取得できる予定のデータは、次のとおりです。

修正前
指定した ID の予定データが返る。
修正後
GRN_SCHD_13001 エラーが発生する。

製品のアップデート情報

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