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

コメントを取得する

レポートのコメント情報を取得する API です。

API名

ReportGetFollows

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

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

リクエスト

パラメーター名	型	パラメーター数	説明
@report_id	base:IDType	1	レポートのID
@limit	xsd:integer	0 ～ 1	取得するコメントの上限
@offset	xsd:integer	0 ～ 1	取得するコメントの開始位置。数値で指定します。

例

<parameters report_id="2" limit="10" offset="0"> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
follow	report:FollowType	0 ～ 無制限	取得したコメント一覧

例

<returns xmlns=""> 
  <follow id="1" number="1" text="followtext" xmlns:flw="http://schemas.cybozu.co.jp/report/2008"> 
    <flw:creator user_id="1" name="Administrator" date="2010-10-12T00:40:48Z" /> 
  </follow> 
</returns>

エラー

エラー番号	説明
GRN_RPRT_31152	指定したレポートが存在しない場合

コメントを追加する

レポートへコメントを追加するAPIです。 下書きには、コメントを追加できません。 また、書式編集を利用したコメントの追加に対応していません。

API名

ReportAddFollows

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

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

リクエスト

パラメーター名	型	パラメーター数	説明
add_follow	report:ReportAddFollowType	1 ～ 無制限	追加するコメントの情報

例

<parameters> 
  <add_follow xmlns="" report_id="2"> 
    <follow xmlns="" id="dummy" text="followtext"></follow> 
  </add_follow> 
</parameters>

レスポンス

パラメーター名	型	パラメーター数	説明
report	report:ReportType	0 ～ 無制限	コメントを追加したレポートの情報

例

<returns> 
  <report id="2" subject="テストフォーム（ 標題 1 ）" is_draft="false"> 
    <items xmlns="http://schemas.cybozu.co.jp/report/2008"> 
      <item name="標題" value="標題 1" /> 
      <files_item name="files" inline="false"> 
        <file file_id="1" name="外部仕様書.txt" size="2801" mime_type="text/plain" /> 
      </files_item> 
    </items> 
    <members xmlns="http://schemas.cybozu.co.jp/report/2008"> 
      <user id="1" name="Administrator" /> 
    </members> 
    <notifyusers xmlns="http://schemas.cybozu.co.jp/report/2008"> 
    </notifyusers> 
    <creator  user_id="1" name="Administrator" date="" /> 
    <modifier user_id="1" name="Administrator" date="" /> 
  </report> 
</returns>

エラー

エラー番号	説明
GRN_RPRT_31152	指定したレポートが存在しない場合

コメントを削除する

コメントを削除するAPIです。 API 実行ユーザーが削除権限を持つコメントに関してのみ削除を行えます。

API名

ReportRemoveFollows

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

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

リクエスト

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

例

<parameters> 
  <follow_id xmlns="">1</follow_id> 
</parameters>

レスポンス

なし

エラー

エラー番号	説明
GRN_RPRT_31181	指定したコメントが存在しない場合
GRN_RPRT_31182	コメントを削除する権限が存在しない場合