メッセージを検索する
メッセージの検索条件をリクエストのパラメーターとして受け取り、指定した条件に当てはまるメッセージの情報をレスポンスとして返す API です。API実行ユーザーが宛先/差出人に含まれているメッセージのみ検索されます。
API名
MessageSearchThreads
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@text | xsd:string | 1 | 検索文字列 |
@start | xsd:dateTime | 1 | 検索期間の開始日時 |
@end | xsd:dateTime | 0 ~ 1 | 検索期間の終了日時 |
@folder_id | base:IDType | 0 ~ 1 | 検索フォルダのID |
@search_sub_folders | xsd:boolean | 0 ~ 1 | サブフォルダの検索
|
@title_search | xsd:boolean | 1 | 標題の検索
|
@body_search | xsd:boolean | 1 | 本文の検索
|
@from_search | xsd:boolean | 1 | 差出人の検索
|
@addressee_search | xsd:boolean | 1 | 宛先の検索
|
@follow_search | xsd:boolean | 1 | コメントの検索
|
例
<parameters text="テスト" start="2010-07-01T00:00:00Z" end="2010-09-01T00:00:00Z" search_sub_folders="true" title_search="true" body_search="true" from_search="true" addressee_search="true" follow_search="true"> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
thread | message:ThreadType | 0 ~ 無制限
|
検索条件に当てはまるメッセージの情報 |
例
<returns xmlns=""> <thread id="103" version="1281422047" confirm="false" subject="テスト標題" is_draft="false"> <th:addressee user_id="2" name="user1" deleted="false" confirmed="false" /> <th:content body="テスト本文" ></th:content> <th:folder id="2" /> <th:creator user_id="1" name="Administrator" date="2010-08-10T06:34:07Z" /> <th:modifier user_id="1" name="Administrator" date="2010-08-10T06:34:07Z" /> </thread> </returns>
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。