コメントを取得、追加、または削除する

コメントを取得する

メッセージ ID とコメントの取得開始位置、取得上限数をリクエストのパラメーターとして受け取り、コメントの情報をレスポンスとして返す API です。

API名

MessageGetFollows

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

• Garoon on cybozu.com
• パッケージ版 バージョン 3.0.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
@thread_id	xsd:string	1	コメントを取得するメッセージID
@offset	xsd:unsignedLong	1	コメントの取得開始位置。コメントの数で指定します。
@limit	xsd:unsignedLong	1	コメントの取得上限数

例

<parameters thread_id="5" offset="0" limit="20"></parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
follow	message:FollowType	0 ～ 無制限 0：指定されたコメントが存在しない	取得されたコメントの情報

例

<returns> 
  <follow id="15" number="2" text="書式編集を使用したコメント"  
   html_text="&lt;p&gt;&lt;strong&gt;&lt;font size=&quot;5&quot;&gt;書式編集を使用したコメント&lt;/font&gt;&lt;/strong&gt;&lt;/p&gt;"> 
    <creator user_id="1" name="Administrator" date="2010-07-09T00:41:19Z" /> 
  </follow> 
  <follow id="14" number="1" text="follow"> 
    <creator user_id="1" name="Administrator" date="2010-07-09T00:40:54Z" /> 
  </follow> 
</returns>

エラー

エラー番号	説明
GRN_MSSG_15003	指定したメッセージIDが存在しない場合

コメントを追加する

メッセージ ID とコメントの情報をリクエストのパラメーターとして受け取り、メッセージにコメントを追加する API です。 この API は、書式編集を利用したコメントの追加に対応していません。

API名

MessageAddFollows

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

• Garoon on cybozu.com
• パッケージ版 バージョン 3.0.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
add_follow	配列	1 ～ 無制限	追加するコメント
add_follow/follow	message:FollowType	1	追加するコメントの情報
add_follow/file	配列	0 ～ 無制限 0：添付ファイルが存在しない	コメントに添付するファイル
add_follow/file/content/text()	xsd:base64Binary	1	添付ファイルデータ
add_follow/file/@id	xsd:string	1	添付ファイルのID

例

<parameters> 
  <add_follow thread_id="5"> 
    <follow id="dummy" number="dummy" text="follow"> 
      <file id="1" name="image.jpg"></file> 
    </follow> 
    <file id="1"> 
      <content>YWJj</content> 
    </file> 
  </add_follow> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
thread	message:ThreadType	0 ～ 無制限	コメントが追加されたメッセージの情報

例

<returns> 
  <thread id="5" version="1278637512" confirm="false" subject="subject" is_draft="false" > 
    <addressee user_id="1" name="Administrator" deleted="false" confirmed="false" /> 
    <content body="content" ></th:content> 
    <follow id="15" number="2" /> 
    <follow id="14" number="1" /> 
    <folder id="2" /> 
    <folder id="3" /> 
    <creator user_id="1" name="Administrator" date="2010-07-07T10:28:40Z" /> 
    <modifier user_id="1" name="Administrator" date="2010-07-07T10:28:40Z" /> 
  </thread> 
</returns>

エラー

エラー番号	説明
GRN_MSSG_15003	指定したメッセージIDが存在しない場合

コメントを削除する

メッセージのコメント ID をリクエストのパラメーターとして受け取り、指定されたコメントを削除する API で す。

API名

MessageRemoveFollows

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

• Garoon on cybozu.com
• パッケージ版 バージョン 3.0.0以降

リクエスト

パラメーター名	型	パラメーター数	説明
follow_id/text()	base:IDType	1 ～ 無制限	削除するコメントのID

例

<parameters> 
  <follow_id>15</follow_id> 
</parameters>

レスポンス

なし

エラー

エラー番号	説明
GRN_MSSG_15004	指定したメッセージIDが存在しない場合