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

Garoon JavaScript API

機能追加

一度下書きとして保存したワークフローや再利用して作成したワークフローを提出したときでも、ワークフロー申請が提出されたときのイベントを利用できる

対象イベント

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

不具合修正

対象イベントまたは API で取得したスケジュールオブジェクトの attendees の値が、画面に表示される「参加者」と異なることがある現象を解消

対象イベント／API

• 予定を登録するときのイベント - schedule.event.create.submit
• 予定を変更するときのイベント - schedule.event.edit.submit
• 予定の値を取得する - garoon.schedule.event.get()

発生条件

次のすべての条件を満たすとき

• 特定のユーザーに対し、予定の他の参加者へ「閲覧」だけを付与する。
• アクセス権を設定したユーザー、および「閲覧」だけを付与したユーザーが参加する予定を作成する。
• 「閲覧」だけを付与したユーザーで対象 API を実行する。

修正内容

対象 API で取得したスケジュールオブジェクトにおける attendees（参加者）の値

• 修正前：アクセス権を設定したユーザーが含まれていない（「閲覧」だけを付与したユーザーのみになる）
• 修正後：画面で表示されている「参加者」がすべて含まれている。

対象イベントで return event したり、予定の値をセットする API を実行したりすると、画面に表示される「参加者」からアクセス権を設定したユーザーが外れることがある現象を解消

対象イベント／API

• 予定の変更画面を表示した後のイベント - schedule.event.edit.show
• 予定を変更するときのイベント - schedule.event.edit.submit
• 予定の値を取得する - garoon.schedule.event.get()

発生条件

次のすべての条件を満たすとき

• 特定のユーザーに対し、予定の他の参加者へ「閲覧」だけを付与する。
• アクセス権を設定したユーザー、および「閲覧」だけを付与したユーザーが参加する予定を作成する。
• 「閲覧」だけを付与したユーザーで、作成した予定に対し対象イベントで return event する、または予定の値をセットする API を実行する。

修正内容

画面上の「参加者」

• 修正前：アクセス権を設定したユーザーが含まれていない（「閲覧」だけを付与したユーザーのみになる）
• 修正後：アクセス権を設定したユーザーも含まれている。

Garoon REST API

機能追加

ワークフローの申請フォーム情報を取得する API を追加

対象 API

• 申請フォームを構成している項目を取得する - /g/api/v1/workflow/admin/forms/{formId} [GET]

不具合修正

実行権限のないユーザーが API を実行したときのエラーメッセージを GRN_CMMN_00005 から GRN_CMMN_00022 に修正

対象 API

• 申請データを取得する - /g/api/v1/workflow/admin/requests [GET]
• 申請データに添付されたファイルを取得する - /g/api/v1/workflow/admin/files/{id} [GET]
• 管理者権限で施設を取得する - /g/api/v1/schedule/admin/facilities [GET]
• 管理者権限で施設を登録する - /g/api/v1/schedule/admin/facilities [POST]
• 管理者権限で施設を更新する - /g/api/v1/schedule/admin/facilities/{id} [PATCH]
• 管理者権限で施設を削除する - /g/api/v1/schedule/admin/facilities/{id} [DELETE]
• 管理者権限で施設グループを取得する - /g/api/v1/schedule/admin/facilityGroups [GET]
• 管理者権限で施設グループを登録する - /g/api/v1/schedule/admin/facilityGroups [POST]
• 管理者権限で施設グループを更新する - /g/api/v1/schedule/admin/facilityGroups/{id} [PATCH]
• 管理者権限で施設グループを削除する - /g/api/v1/schedule/admin/facilityGroups/{id} [DELETE]
• プロキシ API の設定を取得する - /g/api/v1/system/api/admin/proxies/code/{proxyCode} [GET]
• プロキシ API の設定を登録する - /g/api/v1/system/api/admin/proxies [POST]
• プロキシ API の設定を更新する - /g/api/v1/system/api/admin/proxies/code/{proxyCode} [PATCH]
• プロキシ API の設定を削除する - /g/api/v1/system/api/admin/proxies/code/{proxyCode} [DELETE]
• プラグインの基本設定を取得する - /g/api/v1/system/plugin/admin/settings/{pluginId} [GET]

修正内容

• 修正前：GRN_CMMN_00005
• 修正後：GRN_CMMN_00022

Garoon プラグイン

機能追加

Garoon プラグインで、開発元の情報や、同じプラグインかどうかを判別し異なるプラグインの場合に更新できなくする識別子を設定できる

備考

開発元の情報（provider）や、同じプラグインかどうかを判別し異なるプラグインの場合に更新できなくする識別子（plugin_code）は、manifest.json のプロパティとして追加されます。
これらのプロパティは必須項目ではありません。

関連ドキュメント

Garoon プラグイン開発手順

製品のアップデート情報

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