コメント

コメントを操作するための API です。 コメントの親となるアイテム自体を操作する場合はそれぞれの API を使ってください。

チャットのコメントを書き込む場合は、 チャット Push を使用してください。

リクエスト

エンドポイント

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

利用可能な HTTP メソッド

GET, POST

リクエスト制限

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

必須パラメータ

  • entry - 親エントリの ID を指定します。 (GET リクエストのとき)

オプションパラメータ

  • start-index - コレクションを取得する場合のインデクスを指定します。GET の場合のみ有効で、値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。GET の場合のみ有効で、値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • unconfirmed - 未確認のコメントのみを取得する場合に指定します。値は “true” のみ可能です。

レスポンス

要素 説明
/feed/entry/cblCmnt:replyTo 返信先コメント番号。
/feed/entry/cblGood:set いいね!を押しているか。
/feed/entry/cblGood:count いいね!の件数。
/feed/entry/cblStar:set お気に入り登録しているか。
/feed/entry/cblCmnt:replyTo 返信先コメント番号。
/feed/cblCmnt:olderCommentExists さらに古いコメントが存在するか
/feed/cblCmnt:newerCommentExists さらに新しいコメントが存在するか

コメントを取得する

トピックを指定して、コメントを取得します。 各コメントの <title> は空要素です。

Examples

リクエストの例:

GET /api/comment/V2?entry=GROUP,1:1,BOARD,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:cblCmnt="http://schemas.cybozulive.com/comment/2010"
      xmlns:cblSch="http://schemas.cybozulive.com/schedule/2010"
      xmlns:cblGood="http://schemas.cybozulive.com/good/2010"
      xmlns:cblStar="http://schemas.cybozulive.com/star/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-08-03T02:54:33Z</updated>
  <dc:date>2010-08-03T02:54:33Z</dc:date>
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:4</uri>
  </author>
  <cblCmnt:olderCommentExists>true</cblCmnt:olderCommentExists>
  <cblCmnt:newerCommentExists>false</cblCmnt:newerCommentExists>
  <entry cbl:sequence="1">
    <title/>
    <link rel="alternate" href="https://cybozulive.com/mpSchedule/view?eid=1%3A2&amp;fid=7&amp;focusOn=follow"/>
    <link rel="mobile" href="https://m.cybozulive.com/m/mpSchedule/view?eid=1%3A2&amp;fid=7#follow"/>
    <updated>2010-09-03T12:54:33Z</updated>
    <author>
      <name>すずき</name>
    </author>
    <summary type="text">あいうえお、これはテストのコメントです。</summary>
    <cblGood:set>true</cblGood:set>
    <cblGood:count>5</cblGood:count>
    <cblStar:set>false</cblStar:set>
  </entry>
  <entry cbl:sequence="3">
    <title/>
    <link rel="alternate" href="https://cybozulive.com/mpSchedule/view?eid=1%3A2&amp;fid=20&amp;focusOn=follow"/>
    <link rel="mobile" href="https://m.cybozulive.com/m/mpSchedule/view?eid=1%3A2&amp;fid=20#follow"/>
    <updated>2010-09-03T02:54:33Z</updated>
    <author>
      <name>クレモンティーヌ</name>
    </author>
    <summary type="text">こんにちはこんにちは</summary>
    <cblCmnt:replyTo>1</cblCmnt:replyTo>
    <cblGood:set>false</cblGood:set>
    <cblGood:count>0</cblGood:count>
    <cblStar:set>true</cblStar:set>
  </entry>
</feed>

コメントを書き込む

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

注釈

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

要素 説明
/feed/cbl:operation type 属性に insert を指定します。
/feed/id コメントを追加するトピックの ID (必須項目)
/feed/entry/summary 追加するコメントの文章。プレインテキストのみ。(必須項目)
/feed/entry/cblCmnt:replyTo 追加するコメントの返信先コメント番号。(任意項目)

Examples

リクエストの例:

POST /api/comment/V2
Content-Type: application/atom+xml; charset=utf-8
<?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"/>
  <id>GROUP,1:1,BOARD,1:1</id>
  <entry>
    <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"
      xmlns:cblCmnt="http://schemas.cybozulive.com/comment/2010">
  <cbl:operation type="insert"/>
  <id>GROUP,1:1,BOARD,1:1</id>
  <entry>
    <summary type="text">了解です!</summary>
    <cblCmnt:replyTo>2</cblCmnt:replyTo>
  </entry>
</feed>

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

ファイルを添付してコメントを書き込む

ファイルを添付してコメントを追加できます。 ファイルを10個まで添付できますが、個別のファイルは25MB以下とします。 また、トータルのデータサイズの最大値は50MBです。

添付ファイルが存在する場合は、コメントは空文字列でも構いません。 最大文字列長は 20000 文字です。

注釈

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

Content-Type ヘッダーに multipart/form-data を指定して POST します。 フォーム名は次の通りとします。 各パートの文字コードは UTF-8 のみ受け付けます。

  • default - コメント投稿用の XML です。書式や例は コメントを書き込む を参照してください。
  • fileN - 添付ファイルのフォームデータです。 N は 0 以上 9 以下の数字です。

Examples

リクエストの例:

POST /api/comment/V2
Content-Type: multipart/form-data; boundary=----------ThIs_Is_tHe_bouNdaRY_$
------------ThIs_Is_tHe_bouNdaRY_$
Content-Disposition: form-data; name="default"

<?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"/>
  <id>GROUP,1:1,BOARD,1:1</id>
  <entry>
    <summary>添付ファイルが存在するコメントです。</summary>
  </entry>
</feed>
------------ThIs_Is_tHe_bouNdaRY_$
Content-Disposition: form-data; name="file0"; filename="figure.gif"
Content-Type: image/gif
GIF89a
***** バイナリ *****
------------ThIs_Is_tHe_bouNdaRY_$
Content-Disposition: form-data; name="file1"; filename="note.txt"
Content-Type: text/plain
タイトル:
作成日  :
作成者  :

概要
====
------------ThIs_Is_tHe_bouNdaRY_$
Content-Disposition: form-data; name="file2"; filename="schedule.ics"
Content-Type: application/octet-stream
BEGIN:VCALENDAR
PRODID:-//cybozulive.com//Calendar Feed//JA
VERSION:2.0
BEGIN:VEVENT
SUMMARY:Meeting
DESCRIPTION:Discussion
DTSTART:20110606T030000Z
DTEND:20110606T040000Z
END:VEVENT
END:VCALENDAR
------------ThIs_Is_tHe_bouNdaRY_$
Content-Disposition: form-data; name="file3"; filename="data.xml"
Content-Type: text/xml
<?xml version="1.0" encoding="UTF-8"?>
<data>
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
</data>
------------ThIs_Is_tHe_bouNdaRY_$--

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

コメントを削除する

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

コメントに対する添付ファイルも削除されます。

注釈

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

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

Examples

リクエストの例:

POST /api/comment/V2
Content-Type: application/atom+xml; charset=utf-8
<?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,COMMENT,42</id>
  </entry>
</feed>

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

エラーコード

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

  • コメントの文字列が存在しない、あるいは長すぎる場合
  • コメントを書き込む対象となるトピックが存在しない場合
  • 添付したファイルの数やデータサイズが不正な場合
  • 削除しようとしているコメント (もしくはその親となるトピック) が存在しない場合
  • ふたつ以上のコメントの追加および削除を試みた場合

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

システム側のデータがコメント API に未対応の場合にもエラーが返ります。