Garoon API

Garoon APIアップデート履歴

2026年11月10日 Garoon APIアップデート情報

API更新情報

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

概要

クラウド版Garoonで、メッセージの添付ファイルに関するREST APIの不具合を修正しました。
これに伴い、「メッセージの添付ファイル一覧を取得する」「メッセージの添付ファイルを取得する」の2つのAPIで扱う添付ファイルのIDを変更しました。
修正前に取得したIDを保存して利用している場合や、修正前に添付ファイルを削除するREST APIを実行した場合は、 ご確認いただきたいこと を確認してください。
パッケージ版Garoonは、Garoon 6.17 Service Pack 4で修正を予定しています。

メンテナンス日（クラウド版）

2026年11月10日（火）16:00

修正対象

  • クラウド版Garoon
  • パッケージ版Garoon 6.17.0以降（Garoon 6.17 Service Pack 4で修正予定）

修正された不具合

メッセージの添付ファイルには、画面やSOAP APIが使う「添付ファイルのID」と、ファイル自体を示す「ファイルのID」の2種類があります。
これまで、メッセージの添付ファイルを操作する管理者向けREST APIのうち、「一覧を取得する」「取得する」はファイルのIDを扱い、「削除する」は添付ファイルのIDを扱っていました。
環境によっては2つのIDの値が異なるため、次のような場合に、指定したものとは別の添付ファイルを削除してしまう、またはエラー（GRN_MSSG_15009）で削除できない現象が発生していました。

また、次のような場合に、指定した添付ファイルとは異なるファイルを取得する、またはエラー（GRN_MSSG_15009）で取得できない現象が発生していました。

この修正で、一覧取得・添付ファイル取得のREST APIで扱うIDが、画面やSOAP APIと同じ添付ファイルのIDに統一されました。
修正以降は、一覧で取得したIDをそのまま削除に指定して、正しい添付ファイルを削除できます。

なお、各APIのドキュメントでは、修正後のIDも「ファイルのID」と記載しています。
これは上記の「ファイル自体を示すファイルのID」ではなく、添付ファイルのIDを指します。

ご確認いただきたいこと

添付ファイルを取得または削除するREST APIを利用している場合は、修正前に取得・保存したIDを使っていないか確認してください。
修正前に削除APIを実行したことがある場合は、 意図しない削除が起きていないかを確認する方法 も確認してください。

不具合修正に対する影響とその対応方法

修正前にREST APIで取得・保存したIDは、修正後に取得し直してください。
古いIDを使うと、別の添付ファイルを取得・削除するか、エラーになる場合があります。

IDの取得元 IDの使い方 修正後に起きること 対応方法
添付ファイル一覧・添付ファイルを取得するREST API 修正前に保存したIDを削除するREST APIに指定 別の添付ファイルを削除するか、エラーになる場合があります 修正後に添付ファイル一覧を取得するREST APIで、対象のIDを取得し直してください
添付ファイル一覧・添付ファイルを取得するREST API 修正前に保存したIDを取得するREST APIに指定 別の添付ファイルを取得するか、エラーになる場合があります 修正後に添付ファイル一覧を取得するREST APIで、対象のIDを取得し直してください
添付ファイル一覧を取得するREST API 修正後に取得したIDを取得または削除するREST APIに指定 指定した添付ファイルを操作できます 対応不要
画面またはSOAP API 添付ファイルのIDを取得または削除するREST APIに指定 指定した添付ファイルを操作できます 対応不要

対象の添付ファイルでIDの違いを確認する方法

パッケージ版で、修正版を適用する前に、対象の添付ファイルでIDが異なるかを調べる手順です。
クラウド版は修正済みのため、このID比較は不要です。
修正前の削除結果は、 意図しない削除が起きていないかを確認する方法 で確認できます。

  1. メッセージのアプリケーション管理者またはシステム管理者で、確認したい添付ファイルがあるメッセージの詳細画面を開きます。
  2. 添付ファイルのリンクのURLに含まれるrfidの値を確認します。
  3. メッセージの添付ファイル一覧を取得する REST API（/api/v1/message/admin/メッセージID/files）を実行し、同じ添付ファイルのidを確認します。
  4. 2と3で値の異なる添付ファイルは、一覧APIで返されたIDを削除APIに指定すると、不具合につながる可能性があります。

比較結果は確認した添付ファイルに限られます。ほかの添付ファイルでは値の異なる場合があります。
一覧APIで同じ添付ファイルを確認できない場合は、この手順では判定できません。

パッケージ版をご利用の場合

パッケージ版Garoonの修正は、Garoon 6.17 Service Pack 4で予定しています。
修正版を適用するまでは、 メッセージの添付ファイルを削除する REST APIの利用を控えてください。

意図しない削除が起きていないかを確認する方法

修正前に管理者向けREST APIでメッセージの添付ファイルを削除した場合は、次の手順で確認してください。
パッケージ版ではGaroon 6.17.0以降が対象です。

  1. 削除した期間のログを確認します。

    • クラウド版では、cybozu.com共通管理の「監査ログ」を開きます。
    • パッケージ版では、「システム設定」＞「基本システムの管理」＞「ログ」＞「ログ一覧」を開きます。削除実行時にカテゴリー「メッセージ」の重要度「一般情報」が記録対象だったかは、「ログの設定」で確認します。

  2. 「message attachment」を含み、末尾に「by REST API」とある削除記録を探します。
    削除に成功すると、本文の添付またはコメントの添付に応じて、次の形式で1件ずつ記録されます。

    1
2

    [delete] message attachment (file_id:10, message_id:18) by REST API
[delete] message attachment (file_id:10, message_id:18, follow_id:23) by REST API
    • file_idは削除APIに指定したIDです。
    • message_idは実際に添付ファイルが削除されたメッセージのIDです。
    • follow_idは、コメントの添付ファイルが削除された場合のコメントの内部IDです。

  3. スクリプトの実行記録などから、本来削除したかったメッセージと添付ファイルを確認し、削除記録と照合します。

    • メッセージIDが異なる場合、別のメッセージの添付ファイルが削除されています。
    • メッセージIDが同じ場合、メッセージの詳細画面を開き、本来削除したかった添付ファイルが残っていないか確認します。同じメッセージ内の別の添付ファイルを削除した可能性があります。システム管理者は「各アプリケーションの管理」＞「メッセージ」＞「メッセージの検索」からメッセージの詳細を確認できます。

ログには、本来削除したかったメッセージのIDや、削除されたファイル名は記録されません。
エラーで削除されなかった場合も、上記の削除成功の記録は残りません。

必要なログが該当期間を通して残っており、削除成功の記録がない場合は、その期間に削除APIによる削除はなかったと判断できます。
ログが残っていない場合、判断できない場合、または意図しない削除が見つかった場合は、サポートへお問い合わせください。

修正されたAPI一覧

Garoon REST API

メッセージの添付ファイルを削除する （/api/v1/message/admin/messages/attached/添付ファイルID）の動作は変わりません。
これまでどおり添付ファイルのIDで削除します。