掲示板を検索するAPIです。 このAPIは、検索条件をリクエストのパラメーターとして受け取り、指定した条件に当てはまる掲示板の情報をレスポンスとして返します。
BulletinSearchTopics
使用可能なGaroonのバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.1以降
| パラメーター名 |
型 |
パラメーター数 |
説明 |
| @text |
xsd:string |
1 |
検索文字列 |
| @sensitive |
xsd:boolean |
0～1 |
大文字小文字を区別- true：する
- false：しない |
| @start |
xsd:dateTime |
1 |
検索期間の開始日時 |
| @end |
xsd:dateTime |
0～1 |
検索期間の終了日時 |
| @category_id |
base:IDType
|
1 |
検索するカテゴリのID- -1：掲示待ちだけの検索
- -2：下書きのみの検索
- 0：通常掲示のみの検索
|
| @search_sub_categories |
xsd:boolean |
1 |
サブカテゴリの検索 |
| @title_search |
xsd:boolean |
1 |
タイトルの検索 |
| @body_search |
xsd:boolean |
1 |
本文の検索 |
| @from_search |
xsd:boolean |
1 |
作成者の検索 |
| @follow_search |
xsd:boolean |
1 |
コメントの検索true：含めるfalse：含めない |
例
1
2
3
4
5
6
7
8
9
10
11
|
<parameters text="テスト"
sensitive="true"
start="2010-11-03T08:00:00"
end="2010-11-15T08:00:00"
category_id="2"
search_sub_categories="true"
title_search="true"
body_search="true"
from_search="true"
follow_search="true">
</parameters>
|
例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
<returns>
<topic xmlns:th="http://schemas.cybozu.co.jp/bulletin/2008"
id="14" version="1289195656" category_id="2"
can_follow="true" subject="Bu test time" is_draft="false"
published="true" unread="false" expired="false">
<th:content body="edit lan 1"></th:content>
<th:follow id="1" number="6" />
<th:creator user_id="1" name="Administrator" date="2010-11-08T14:53:22Z" />
<th:modifier user_id="1" name="Administrator" date="2010-11-08T14:54:16Z" />
</topic>
<topic xmlns:th="http://schemas.cybozu.co.jp/bulletin/2008"
id="10" version="1289178877" category_id="4"
can_follow="true" subject="Bu11" is_draft="false"
published="true" unread="false" expired="false">
<th:content body=""></th:content>
<th:creator user_id="1" name="Administrator" date="2010-11-08T10:14:37Z" />
<th:modifier user_id="1" name="Administrator" date="2010-11-08T10:14:37Z" />
</topic>
<returns>
|
| エラー番号 |
説明 |
| GRN_BLLT_16006 |
開始日時が終了日時より後の場合 |
| GRN_BLLT_16002 |
指定したカテゴリが存在しない場合 |
| GRN_BLLT_16050 |
掲示を閲覧する権限が存在しない場合 |
