掲示板を取得する – cybozu developer network

Index

掲示板の更新情報を取得する
掲示板の下書きの更新情報を取得する
掲示板の一覧を取得する
掲示板の情報を取得する

掲示板の更新情報を取得する

掲示板のバージョン情報を取得するAPIです。

API名

BulletinGetTopicVersions

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

クラウド版 Garoon
パッケージ版 Garoon バージョン 3.1.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
@start	xsd:dateTime	1	掲示の最終更新日時（検索対象の開始日時）
@end	xsd:dateTime	0 ～ 1	掲示の最終更新日時（検索対象の終了日時）
topic_item	base:ItemVersionType	0 ～無制限	掲示板のバージョン情報
category_id/text()	base:IDType	0 ～無制限	カテゴリID 次の値を指定できます。 1〜：カテゴリID（通常掲示のみ） -1：掲示開始待ちの掲示

例

<parameters start="2010-11-02T08:00:00Z"  end="2010-11-04T08:00:00Z"> 
  <topic_item xmlns="" id="4" version=”1288029380”> 
  </topic_item> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
topic_item	base:ItemVersionResultType	0 ～無制限	掲示板の更新情報

例

<returns> 
  <topic_item id="4" version="1288838258" operation="add" /> 
  <topic_item id="2" version="1288842674" operation="add" /> 
  <topic_item id="6" version="1288843195" operation="add" /> 
</returns>

エラー

エラー番号	説明
GRN_BLLT_16006	@start が @end より後の場合
FW00034	日時情報が間違っている場合。月に13、日に35が含まれているなど。

掲示板の下書きの更新情報を取得する

掲示板の下書きのバージョン情報を取得する API です。

API名

BulletinGetDraftTopicVersions

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

クラウド版 Garoon
パッケージ版 Garoon バージョン 3.1.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
@start	xsd:dateTime	1	掲示の最終更新日時（検索対象の開始日時）
@end	xsd:dateTime	0 ～ 1	掲示の最終更新日時（検索対象の終了日時）
topic_item	base:ItemVersionType	0 ～無制限	掲示板の下書きのバージョン情報

例

<parameters start="2010-11-03T08:00:00Z" end="2010-11-10T08:00:00Z"> 
  <topic_item xmlns="" id="1" version="11111111111"> 
  </topic_item> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
topic_item	base:ItemVersionResultType	0 ～無制限	掲示板の下書きの更新情報

例

<returns> 
  <topic_item id="1" version="0" operation="remove" /> 
  <topic_item id="2" version="1288839022" operation="add" /> 
</returns>

掲示板の一覧を取得する

掲示板を取得するAPIです。このAPIは、カテゴリのIDをリクエストとして受け取り、指定したカテゴリに属す掲示板のリストをレスポンスとして返します。

API名

BulletinGetTopics

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

クラウド版 Garoon
パッケージ版 Garoon バージョン 3.1.0以降

リクエスト

パラメーター名

型

パラメーター数

説明

category_id

base:IDType

1 ～無制限

カテゴリID
次の値を指定できます。

1〜：カテゴリID（通常掲示のみ）
-1：掲示開始待ちの掲示
-2：下書きの掲示

例

<parameters> 
  <category_id xmlns="">3</category_id> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
category	bulletin:TopicListType	0 ～無制限	カテゴリに属する掲示板の一覧

例

<returns xmlns=""> 
  <category category_id="3"> 
    <topic id="10" /> 
    <topic id="9" /> 
    <topic id="8" /> 
    <topic id="7" /> 
    <topic id="6" /> 
    <topic id="4" /> 
    <topic id="3" /> 
    <topic id="2" /> 
  </category> 
</returns>

エラー

エラー番号	説明
GRN_BLLT_16002	カテゴリが存在しない場合
GRN_BLLT_16050	カテゴリの閲覧権限がないユーザーが実行した場合

掲示板の情報を取得する

掲示板の詳細情報を取得するAPIです。この API は、掲示板の ID をリクエストとして受け取り、掲示板の詳細情報をレスポンスとして返します。

API名

BulletinGetTopicByIds

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

クラウド版 Garoon
パッケージ版 Garoon バージョン 3.1.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
@topic_id	base:IDType	1 ～無制限	取得する掲示板ID
@is_draft	xsd:boolean	1 ～無制限	true：下書き false：下書きでない

例

<parameters> 
  <topics xmlns="" topic_id="2" is_draft="false"></topics> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
topic	bulletin:TopicType	0 ～無制限	取得した掲示板情報

例

<returns> 
  <topic xmlns:th="http://schemas.cybozu.co.jp/bulletin/2008" 
   id="2" version="1288755034" 
   category_id="3" 
   can_follow="true" 
   subject="modify" 
   is_draft="false" 
   published="true" 
   unread="true" 
   expired="false" > 
    <th:content body="body" > 
      <th:file id="4" name="test.txt" size="100" mime_type="text/plain"/> 
      <th:file id="5" name="test2.txt" size="100" mime_type="text/plain"/> 
    </th:content> 
    <th:follow id="1" number="12" /> 
    <th:creator user_id="1" name="Administrator" date="2010-11-03T11:45:57Z" /> 
    <th:modifier user_id="1" name="Administrator" date="2010-11-03T12:30:34Z" /> 
  </topic> 
</returns>