メッセージを検索する

メッセージの検索条件をリクエストのパラメーターとして受け取り、指定した条件に当てはまるメッセージの情報をレスポンスとして返す 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	サブフォルダの検索 true：含める false：含めない
@title_search	xsd:boolean	1	標題の検索 true：含める false：含めない
@body_search	xsd:boolean	1	本文の検索 true：含める false：含めない
@from_search	xsd:boolean	1	差出人の検索 true：含める false：含めない
@addressee_search	xsd:boolean	1	宛先の検索 true：含める false：含めない
@follow_search	xsd:boolean	1	コメントの検索 true：含める false：含めない

例

<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 ～無制限 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>

メッセージを検索する

API名

使用可能なガルーンのバージョン

リクエスト

レスポンス

記事に関するフィードバック