2022年8月14日Garoon APIアップデート情報
API更新情報
2022年8月14日に実施するメンテナンスにおける、Garoon APIのアップデート内容は次のとおりです。
Garoon JavaScript API
機能追加
メールの詳細画面を表示したときのイベントを追加
対象 イベント
-
メール詳細画面を表示したときのイベント
-
mail.mail.detail.show
備考
プレビュー表示あり(3ペイン)の場合には、プレビューを表示したときにイベントが発生します。
メールの詳細画面で、メールの標題の下の要素を取得するAPIを追加
対象API
-
メールの「標題」下の空白要素を取得する
-
garoon.mail.mail.getMailSubjectSpaceElement()
備考
プレビュー表示あり(3ペイン)の場合には、プレビューを表示したときに要素を取得します。
機能改善
対象APIを使って、外部 にAPIリクエストを送信してからタイムアウトするまでの時間を、10秒から30秒に変更
対象API
-
外部 のAPIを実行する
-
garoon.base.proxy.send()
備考
30秒を過ぎると「GRN_CMMN_03008」エラーが返ります。
不具合修正
対象イベントまたはAPIで取得した、申請を処理するときのコメントに含まれる日時や改行コードが正しくないことがある現象を解消
対象イベント/API
-
ワークフロー申請を提出したときのイベント
-
workflow.request.create.submit.success
-
ワークフロー申請の承認画面を表示したときのイベント
-
workflow.request.approve.show
-
ワークフロー申請を承認したときのイベント
-
workflow.request.approve.submit.success
-
ワークフロー申請の詳細画面を表示したときのイベント
-
workflow.request.detail.show
-
ワークフロー申請を確認したときのイベント
-
workflow.request.acknowledge.submit.success
-
ワークフロー申請の印刷用画面を表示したときのイベント
-
workflow.request.print.show
-
申請データの値を取得する
-
garoon.workflow.request.get()
修正内容
申請を処理するとき、投稿するコメント(steps.ステップコード.processors[].comment
)に含まれる、次の値の書式が修正されます。
- 修正前:
- 承認日時/差し戻し日時:ISO 8601形式
- 改行コード:エスケープされている(
\\n
)
- 修正後:
- 承認日時/差し戻し日時:APIを実行するユーザーが設定した、日時の表示形式の設定の「日付の長い形式」の形式と同じ。
- 改行コード:エスケープされていない(
\n
)
Garoon REST API
不具合修正
複数の予定を取得するAPIで、リクエストパラメーターにshowPrivate=falseを指定すると、閲覧権限のない予定の一部情報を取得してしまう現象を解消
対象API
-
複数の予定を取得する
-
/g/api/v1/schedule/events
[GET]
発生条件
リクエストパラメーターにshowPrivate=false
を指定して、対象APIを実行する。
修正内容
- 修正前:
APIを実行するユーザーに閲覧権限のない予定の一部情報を含んだ予定一覧も取得できてしまう。 - 修正後:
APIを実行するユーザーに閲覧権限のない予定の一部情報は取得できない。
showPrivate
を指定せずに実行したときと同じで、閲覧権限のある予定だけを返します。
通知の取得APIで、作成者のユーザーが削除されている通知を取得すると、エラーが発生する現象を解消
対象API
-
通知を取得する
-
/g/api/v1/notification/items
[GET]
修正内容
- 修正前:
PHP00004エラーが発生してしまう。 - 修正後:
通知の内容を取得できる。
対象APIで取得した、申請を処理するときのコメントに含まれる日時や改行コードが正しくないことがある現象を解消
対象API
-
申請データを取得する
-
/g/api/v1/workflow/admin/requests
[GET]
修正内容
申請を処理するとき、投稿するコメント(steps.ステップコード.processors[].comment
)に含まれる、次の値の書式が修正されます。
- 修正前:
- 承認日時/差し戻し日時:ISO 8601形式
- 改行コード:エスケープされている(
\\n
)
- 修正後:
- 承認日時/差し戻し日時:APIを実行するユーザーが設定した、日時の表示形式の設定の「日付の長い形式」の形式と同じ。
- 改行コード:エスケープされていない(
\n
)
製品のアップデート情報
API以外のGaroonのアップデートに関する情報は、
クラウド版Garoon更新情報
を参照してください。
8月定期メンテナンス分は後日公開されます。