掲示板を作成、更新、または削除する

目次

掲示板を作成する

掲示板を作成するAPIです。 このAPIは、作成する掲示板の情報をリクエストとして受け取り、作成した掲示板情報をレスポンスとして返します。掲示板の本文の書式は編集できません。

API名

BulletinCreateTopics

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

リクエスト

パラメーター名 パラメーター数 説明
create_topic bulletin:BulletinCreateTopicType 1~ 無制限 作成する掲示板の情報
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
<parameters>
  <create_topic xmlns="">
    <topic xmlns="" id="dummy" version="dummy" subject="Test create topic"
     can_follow="false" category_id="3">
      <content body="topic content">
        <file id="1" name="test.txt" mime_type="text/plain"></file>
      </content>
    </topic>
    <file xmlns="" id="1">
     <content xmlns="">77u/DQoNCiogVGhpbmsNCiAgLSBUcnkgYXBwbHkgcHJvYmxlbSBzb2x2aW5nIG1ldGhvZCBsZWFybmVkIGZyoLg0K</content>
    </file>
  </create_topic>
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
topic bulletin:TopicType 0~ 無制限 作成した掲示板の情報
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
<returns>
  <topic xmlns:th="http://schemas.cybozu.co.jp/bulletin/2008" id="33"version="1288946368"
   category_id="3"can_follow="false" subject="Test create topic"
   is_draft="false" published="true" unread="false"  expired="false" >
    <th:content body="topic content" >
      <th:file id="60" name="test.txt" size="100" mime_type="text/plain"/>
    </th:content>
    <th:creator user_id="1" name="Administrator" date="2010-11-05T17:39:28Z" />
    <th:modifier user_id="1" name="Administrator" date="2010-11-05T17:39:28Z" />
  </topic>
</returns>

エラー

エラー番号 説明
GRN_BLLT_16002 存在しないカテゴリIDを指定した場合
GRN_BLLT_16073 bulletin:TopicTypeの@manually_enter_senderに空文字を指定した場合
GRN_UTIL_API_65009 アップロードするファイルのサイズが、BASE64エンコード後で300MBより大きい場合

下書きを保存する

掲示板の情報をリクエストで受け取り、下書きに保存するAPIです。このAPIは、書式編集を利用した下書き保存に対応していません。

API名

BulletinSaveDraftTopics

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

リクエスト

パラメーター名 パラメーター数 説明
save_draft_topic bulletin:BulletinCreateTopicType 1~ 無制限 作成する掲示板の下書きの情報
1
2
3
4
5
6
7
8
<parameters>
  <save_draft_topic xmlns="">
    <topic xmlns="" id="dummy" version="dummy" subject="Test save to draft"
     can_follow="true" category_id="3">
      <content body="content"></content>
    </topic>
  </save_draft_topic>
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
topic bulletin:TopicType 0~ 無制限 作成した掲示板の下書きの情報
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
<returns>
  <topic xmlns:th="http://schemas.cybozu.co.jp/bulletin/2008"
   id="14" version="1289184163"
   category_id="-2"
   can_follow="true" subject="Test save to draft"
   is_draft="true"
   published="false"  expired="false" >
    <th:content body="content" ></th:content>
    <th:creator user_id="1" name="Administrator" date="2010-11-08T11:42:43Z" />
    <th:modifier user_id="1" name="Administrator" date="2010-11-08T11:42:43Z" />
  </topic>
</returns>

エラー

エラー番号 説明
GRN_BLLT_16006 開始日時が終了日時より後の場合
GRN_BLLT_16069 標題がない場合
GRN_BLLT_16073 bulletin:TopicTypeの@manually_enter_senderに空文字を指定した場合
GRN_UTIL_API_65009 アップロードするファイルのサイズが、BASE64エンコード後で300MBより大きい場合

掲示板を更新する

掲示板を更新するAPIです。このAPIは、書式編集を利用した掲示板の更新に対応していません。

API名

BulletinModifyTopics

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

リクエスト

パラメーター名 パラメーター数 説明
modify_topic bulletin:BulletinModifyTopicType 1~ 無制限 更新する掲示板の下書きの情報
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
<parameters>
  <modify_topic xmlns="">
    <topic xmlns="" id="2" version="dummy" subject="topic modify" can_follow="false"
     category_id="3">
      <content body="content modify">
        <file id="1" name="file.txt" mime_type="text/plain"></file>
      </content>
    </topic>
    <file xmlns="" id="1">
      <content xmlns="">77u/DQoNCiogVGhpbmsNCiAgLSBUcnkgYXBwbHkgcHJvYmxlbSBzb2x2aW5nIG1ldGhvZCBsZWFybmVkIGZy
      </content>
    </file>
  </modify_topic>
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
topic bulletin:TopicType 0~ 無制限 更新された掲示板の下書きの情報
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<returns>
  <topic xmlns:th="http://schemas.cybozu.co.jp/bulletin/2008"
   id="2" version="1289196675"
   category_id="3" can_follow="false" subject="topic modify"
   is_draft="false"  published="true"   unread="false"  expired="false" >
    <th:content body="content modify" >
      <th:file id="61" name="file.txt" size="200" mime_type="text/plain"/>
    </th:content>
    <th:follow id="4" number="15" />
    <th:follow id="3" number="14" />
    <th:follow id="2" number="13" />
    <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-08T15:11:15Z" />
  </topic>
</returns>

エラー

エラー番号 説明
GRN_BLLT_16003 指定した掲示板が存在しない場合
GRN_BLLT_16006 開始日時が終了日時より後の場合
GRN_BLLT_16073 bulletin:TopicTypeの@manually_enter_senderに空文字を指定した場合
GRN_UTIL_API_65009 アップロードするファイルのサイズが、BASE64エンコード後で300MBより大きい場合

掲示板を削除する

掲示板のIDをもとに掲示板を削除するAPIです。

API名

BulletinRemoveTopics

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.1以降

リクエスト

パラメーター名 パラメーター数 説明
@topic_id base:IDType 1 削除する掲示板のID
@is_draft xsd:boolean 1
  • true:下書き
  • false:下書きでない
1
2
3
<parameters>
  <topics xmlns="" topic_id="14" is_draft="false"></topics>
</parameters>

レスポンス

なし

エラー

エラー番号 説明
GRN_BLLT_16003 指定した掲示板が存在しない場合
GRN_BLLT_16005 指定した掲示板の下書きが存在しない場合