2021年5月9日 Garoon API アップデート情報
2021 年 5 月 9 日に実施するメンテナンスにおける、Garoon API のアップデート内容は次のとおりです。
今月の Garoon API
5 月版のメンテナンスでは、スケジュールでカスタム項目(Schedule datastore)を保存できる機能がリリースされます。
この機能は、予定にカスタマイズごとの追加情報を保存できる機能です。
これまでも
カスタム項目(additionalItems)に関するプロパティ という項目で予定の追加情報を保存できました。
しかし複数のカスタマイズを適用する場合、カスタマイズ項目(additionalItems)は同時に利用できませんでした。
カスタム項目(Schedule datastore)を利用すると、複数のカスタマイズを適用した場合でも、競合を気にせず予定へ追加情報を保存できます。
なお、カスタム項目(additonalItems)は、今後、1 年程度を目処に廃止する予定です。詳細は Garoon スケジュールのカスタム項目(additionalItems)の廃止予定について を参照してください。
Garoon JavaScript API
機能追加
スケジュールのカスタム項目(Schedule datastore)に値を登録/取得できる API を追加しました
対象 API
-
カスタム項目(Schedule datastore)の値を取得する -
garoon.schedule.event.datastore.get()
-
カスタム項目(Schedule datastore)の値をセットする -
garoon.schedule.event.datastore.set()
予定の削除前イベントを追加しました
対象 API
予定を削除するときのイベント - schedule.event.delete.submit
備考
予定の削除画面で「はい」をクリックしたときに発行するイベントです。
予定の削除後イベントを追加しました
対象 API
予定の削除に成功したときのイベント - schedule.event.delete.submit.success
備考
予定の削除が成功したときに発行するイベントです。
外部 API の実行 API のHTTP リクエストメソッドで、PATCH を利用できるようになりました
対象 API
外部の API を実行する - garoon.base.proxy.send()
Garoon REST API
機能追加
スケジュールのカスタム項目(Schedule datastore)の値を取得、登録、更新、削除できる API を追加しました
対象 API
-
予定のカスタム項目(Schedule datastore)を取得する -
/g/api/v1/schedule/events/{eventId}/datastore/{customizeName}
[GET] -
予定のカスタム項目(Schedule datastore)を登録する -
/g/api/v1/schedule/events/{eventId}/datastore/{customizeName}
[POST] -
予定のカスタム項目(Schedule datastore)を更新する -
/g/api/v1/schedule/events/{eventId}/datastore/{customizeName}
[PUT] -
予定のカスタム項目(Schedule datastore)を削除する -
/g/api/v1/schedule/events/{eventId}/datastore/{customizeName}
[DELETE]
不具合修正
ワークフローで、申請データを対象 API で取得したとき、項目データの「項目コード」を正しく取得できない場合がある現象を解消しました
対象 API
申請データを取得する - /g/api/v1/workflow/admin/requests
[GET]
発生条件
次のすべての条件を満たすとき
- 「項目コード」に数値を設定した申請フォームを作成する。
- 上記の申請フォームで申請データを作成する。
- 対象 API で申請データを取得する。
修正内容
- 修正前
- 「項目コード」の値が項目データの通し番号になる。
- 修正後
- 「項目コード」の値が申請フォームで設定された値になる。
今回の修正に対する影響
次の場合のいずれにも当てはまるワークフローの場合、取得できる項目の値が変わる可能性があります。
申請フォームの設定および適用しているカスタマイズの内容を確認してください。
- 申請フォームの設定で、「項目コード」に数字を設定している。
- カスタマイズ内で、「項目コード」をキーに項目の値を取得している。
Garoon 製品
不具合修正
アプリケーションに適用したカスタマイズが、カスタマイズグループの一覧の並び順に読み込まれない不具合を修正しました
修正内容
アプリケーションに複数のカスタマイズを適用している場合、次の修正が適用されます。
- 修正前
- カスタマイズグループの更新が古い順に読み込まれる。
- 修正後
- カスタマイズグループの一覧の並び順に読み込まれる。
今回の修正に対する影響
複数のカスタマイズを適用している場合、カスタマイズで表示している内容や動きが変わる可能性があります。
Garoon のシステム管理者は、カスタマイズグループの一覧の並び順(カスタマイズが実行される順番)をあらためて確認してください。
製品のアップデート情報
API 以外の Garoon のアップデートに関する情報は、
クラウド版 Garoon 更新情報
を参照してください。
5 月定期メンテナンス分は後日公開されます。