メッセージの更新情報を取得する
メッセージの ID と version、フォルダ ID、取得期間をリクエストのパラメーターとして受け取り、メッセージの更新情報を返す API です。 リクエストで受け取った version とガルーンが持つ version が異なる場合、レスポンスでそのメッセージのoperation は、”modify”となります。 リクエストで受け取らなかったメッセージが存在する場合、レスポンスでそのメッセージの operationは、”add”となります。 API実行ユーザーが宛先/差出人に含まれていない場合や、存在しないメッセージをリクエストで受け取った場合、レスポンスでそのメッセージの operationは、”remove”となります。これらの情報は更新情報であり、本APIによって更新が行われることはありません。
API名
MessageGetThreadVersions
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
thread_item | base:ItemVersionType | 0 ~ 無制限
|
更新情報を取得するメッセージのIDとバージョン |
folder_id/text() | base:IDType | 0 ~ 無制限
|
更新情報を取得するフォルダのID |
@start | xsd:dateTime | 1 | 取得期間の開始日時 |
@end | xsd:dateTime | 0 ~ 1
|
取得期間の終了日時 |
例
<parameters start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z"> <thread_item id="2" version="1"></thread_item> <folder_id>2</folder_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
folder_item | base:ItemVersionResultType | 0 ~ 無制限
|
folder_itemで指定されたフォルダの更新情報 |
例
<returns> <thread_item id="2" version="0" operation="remove" /> <thread_item id="3" version="1278417620" operation="add" /> </returns>
メッセージを取得する
メッセージ ID をリクエストのパラメーターとして受け取り、指定したメッセージの情報をレスポンスとして返す API です。API実行ユーザーが宛先/差出人に含まれているメッセージのみ取得されます。
API名
MessageGetThreadsById
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
thread_id/text() | xsd:string | 1 ~ 無制限 | メッセージ情報を取得するメッセージのID |
例
<parameters> <thread_id>2</thread_id> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
thread | message:ThreadType | 0 ~ 無制限 | 取得したメッセージの情報 |
例
<returns> <thread id="2" version="10000" confirm="false" subject="テスト" is_draft="false"> <addressee user_id="1" name="佐藤" deleted="false" confirmed=”false” /> <content body="本文" html_body="<p>書式付本文</p>"> <file id="1" name="ファイル.txt" size="1000" mime_type="text/plain" /> </content> <follow id="2" number="2" /> <follow id="1" number="1" /> <creator user_id="1" name="佐藤" date="2009-02-02T00:00:00" /> <modifier user_id="1" name="佐藤" date="2009-02-02T00:00:00" /> </thread> </returns>
エラー
エラー番号 | 説明 |
GRN_MSSG_15003 | 指定したメッセージIDが存在しない場合 |
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。