掲示板

グループの掲示板の情報を操作するための API です。

掲示の個別のデータを「トピック」、トピックに紐づくデータを「コメント」と表します。 コメントのデータを操作するためにはコメント API を確認してください。

リクエスト

エンドポイント

  • https://api.cybozulive.com/api/board/V2

利用可能な HTTP メソッド

GET, POST

リクエスト制限

  • POST するデータが大きすぎる場合にはリクエストを拒否します。

指定グループのトピックを取得する

グループの ID を指定して、トピックを取得します。

必須パラメータ

  • group - グループの ID を指定します。

オプションパラメータ

  • embed-comment - “true” の場合にコメントも取得します。コメントへのアクセス権が必要です。
  • start-index - コレクションを取得する場合のインデクスを指定します。値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • board-folder - 絞り込むカテゴリを指定します。値はID文字列を指定するか、”UNCLASSIFIED” で未分類、”TRASH” でごみ箱を指定します。

レスポンス

要素 説明
/feed/entry/cbl:group グループ。
/feed/entry/cblBrd:allowEdit 共同編集が有効な状態。
/feed/entry/cblBrd:fastNotify 緊急連絡が有効な状態。
/feed/entry/cbl:comments/cbl:feedLink コメント。

Examples

リクエストの例:

GET /api/board/V2?group=1:1

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblBrd="http://schemas.cybozulive.com/board/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <id>GROUP,1:1</id>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-10-29T02:39:46Z</updated>
  <dc:date>2010-10-29T02:39:46Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <title>引っ越しのお知らせ</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwBoard/view?bid=1%3A1" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwBoard/modify?bid=1%3A1" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwBoard/view?bid=1%3A1" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/1_1/gwBoard/modify?bid=1%3A1" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwBoard/delete?bid=1%3A1" />
    <category term="GROUP" />
    <category term="BOARD" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,BOARD,1:1</id>
    <updated>2010-10-28T03:39:46Z</updated>
    <summary type="text"></summary>
    <cblBrd:fastNotify />
    <cblBrd:folder valueString="お知らせ" id="1:5" />
    <cbl:published>2010-10-28T03:39:46Z</cbl:published>
    <cbl:confirmed>true</cbl:confirmed>
    <cbl:group valueString="グループウェア1" id="1:1"/>
  </entry>
  <entry>
    <title>年賀状</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwBoard/view?bid=1%3A10" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwBoard/modify?bid=1%3A10" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwBoard/view?bid=1%3A10" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/1_1/gwBoard/modify?bid=1%3A10" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwBoard/delete?bid=1%3A10" />
    <category term="GROUP" />
    <category term="BOARD" />
    <author>
      <name>brown</name>
      <uri>2:8</uri>
    </author>
    <id>GROUP,1:1,BOARD,1:10</id>
    <updated>2010-10-28T02:49:46Z</updated>
    <summary type="text"></summary>
    <cblBrd:allowEdit />
    <cbl:published>2010-10-28T02:39:46Z</cbl:published>
    <cbl:confirmed>false</cbl:confirmed>
    <cbl:group valueString="グループウェア1" id="1:1"/>
  </entry>
</feed>

注釈

embed-comment=true を指定するとコメントも取得できますが、ページングなどはサポートしていません。 必要な場合は コメント API を使用してください。

また、コメント用のサブフィードには <summary> 要素と <content> 要素に同じ値を含みます。 将来的な コメント API との互換性のため、できるだけ <summary> 要素を使用してください。

特定のトピックを取得する

ID を指定して、トピックを取得します。

必須パラメータ

  • entry - トピック ID を指定します

オプションパラメータ

  • embed-comment - “true” の場合にコメントも取得します。コメントへのアクセス権が必要です。

レスポンス

グループ ID を指定した場合と同様の形式のレスポンスを返します。

Examples

リクエストの例:

GET /api/board/V2?entry=GROUP,1:1,BOARD,1:5

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblBrd="http://schemas.cybozulive.com/board/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <id>GROUP,1:1</id>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2015-08-11T02:39:46Z</updated>
  <dc:date>2015-08-11T02:39:46Z</dc:date>
  <author>
    <name>田中 美子</name>
    <email>tanaka@example.com</email>
    <uri>1:11</uri>
  </author>
  <entry>
    <title>花火大会開催</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwBoard/view?bid=1%3A5" />
    <link rel="edit" href="https://cybozulive.com/1_1/gwBoard/modify?bid=1%3A5" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwBoard/view?bid=1%3A5" />
    <link rel="mobile-edit" href="https://m.cybozulive.com/m/1_1/gwBoard/modify?bid=1%3A5" />
    <link rel="mobile-delete" href="https://m.cybozulive.com/m/1_1/gwBoard/delete?bid=1%3A5" />
    <category term="GROUP" />
    <category term="BOARD" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>GROUP,1:1,BOARD,1:5</id>
    <updated>2015-08-11T03:39:46Z</updated>
    <summary type="text"></summary>
    <cblBrd:fastNotify />
    <cblBrd:folder valueString="お知らせ" id="1:5" />
    <cbl:published>2015-08-11T03:39:46Z</cbl:published>
    <cbl:confirmed>true</cbl:confirmed>
    <cbl:group valueString="グループウェア1" id="1:1"/>
  </entry>
</feed>

コメントを書き込む

トピックの ID を指定して、そのコメントを追加できます。 コメントの最大文字列長は 20000 文字です。

なお、コメントの扱いに関しては コメント API を推奨します。 将来的な機能追加はコメント API で行われる予定です。

注釈

アプリケーションは書き込み権限のあるアクセスレベルでなければなりません。

要素 説明
/feed/id コメントを追加するトピックの ID (必須項目)
/feed/entry/summary 追加するコメントの文章。プレインテキストのみ。(必須項目)

Examples

リクエストの例:

POST /api/board/V2
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <id>GROUP,1:1,BOARD,1:1</id>
  <entry>
    <summary type="text">コメントの書き込み API もよろしくおねがいします!</summary>
  </entry>
</feed>

正常に書き込みが成功した場合には200番台のレスポンスが返ります。

トピックを作成する

グループを指定して、トピックを作成できます。 トピックはひとつずつしか作成できません。添付ファイルは追加できません。

タイトルの最大文字列長は 200 文字、本文の最大文字列長は 20000 文字です。

注釈

アプリケーションは書き込み権限のあるアクセスレベルでなければなりません。

要素 説明
/feed/cbl:operation type 属性に insert を指定します。
/feed/entry/title 追加するトピックのタイトル。プレインテキストのみ。(必須項目)
/feed/entry/summary 追加するコメントの文章。プレインテキストのみ。
/feed/entry/cbl:group トピックを追加するグループ。(必須項目)

Examples

リクエストの例:

POST /api/board/V2
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <cbl:operation type="insert"/>
  <entry>
    <cbl:group id="1:2" />
    <title>あたらしいトピック</title>
    <summary type="text">API を使った投稿です。</summary>
  </entry>
</feed>

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <entry>
    <id>GROUP,1:2,BOARD,1:1</id>
    <cbl:group id="1:2" />
    <title>あたらしいトピック</title>
    <updated>2011-02-26T07:52:55Z</updated>
    <summary type="text">API を使った投稿です。</summary>
  </entry>
</feed>

トピックを変更する

トピックの ID を指定して、そのトピックのタイトルおよび本文を変更できます。 トピックはひとつずつしか変更できません。添付ファイルは変更できません。 差分更新ではなく、送信データによる上書きとして機能します。 summary を省略した場合は、本文は空文字列になりますので注意してください。

コメントや設定情報は変更されません。

注釈

アプリケーションは書き込み権限のあるアクセスレベルでなければなりません。

要素 説明
/feed/cbl:operation type 属性に update を指定します。(必須項目)
/feed/entry/id 変更するトピックの ID。(必須項目)
/feed/entry/title 変更するトピックのタイトル。プレインテキストのみ。(必須項目)
/feed/entry/summary 変更するトピックの文章。プレインテキストのみ。
NOTE:
既存の本文で書式編集を使っていた場合は、プレインテキストで上書きされます。 API での書式編集のサポートは未定です。

Examples

リクエストの例:

POST /api/board/V2
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <cbl:operation type="update"/>
  <entry>
    <id>GROUP,1:2,BOARD,1:1</id>
    <title>トピックの変更</title>
    <summary type="text">API から変更します。</summary>
  </entry>
</feed>

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <entry>
    <id>GROUP,1:2,BOARD,1:1</id>
    <cbl:group id="1:2" />
    <title>トピックの変更</title>
    <updated>2011-02-24T07:52:55Z</updated>
    <summary type="text">API から変更します。</summary>
  </entry>
</feed>

トピックを削除する

トピックの ID を指定して、そのトピックを削除できます。 トピックはひとつずつしか削除できません。

トピック本文に対する添付ファイルも削除されます。 トピックに関するコメントおよび添付ファイルも削除されます。

注釈

アプリケーションは書き込み権限のあるアクセスレベルでなければなりません。

要素 説明
/feed/cbl:operation type 属性に delete を指定します。(必須項目)
/feed/entry/id 削除するトピックの ID。(必須項目)

Examples

リクエストの例:

POST /api/board/V2
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <cbl:operation type="delete"/>
  <entry>
    <id>GROUP,1:1,BOARD,1:1</id>
  </entry>
</feed>

正常に削除が成功した場合には200番台のレスポンスが返ります。

エラーコード

書き込み用のデータが不正な場合にはエラーの XML が返ります。 <error> 要素の中身を確認してください。

  • トピックタイトルの文字列が存在しない、あるいは長すぎる場合
  • トピック本文の文字列が長すぎる場合
  • トピックを作成するグループに参加していない場合
  • 変更または削除しようとしているトピックが存在しない場合
  • ふたつ以上のトピックの変更または削除を試みた場合
  • トピックが他のユーザーによって変更中である場合

アプリケーションに権限が不足している場合、書き込み先グループが間違っている場合もエラーが返ります。