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

固定リンクがコピーされました

コメントを取得する

固定リンクがコピーされました

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

API名

固定リンクがコピーされました

ReportGetFollows

利用できるバージョン

固定リンクがコピーされました

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

リクエスト

固定リンクがコピーされました

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

例

1
2


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

レスポンス

固定リンクがコピーされました

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

例

1
2
3
4
5


<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
パッケージ版Garoon 3.0以降

リクエスト

固定リンクがコピーされました

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

例

1
2
3
4
5


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

レスポンス

固定リンクがコピーされました

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

例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


<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	指定したレポートが存在しない場合
GRN_UTIL_API_65009	アップロードするファイルのサイズが、Base64エンコード後で300MBより大きい場合

コメントを削除する

固定リンクがコピーされました

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

API名

固定リンクがコピーされました

ReportRemoveFollows

利用できるバージョン

固定リンクがコピーされました

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

リクエスト

固定リンクがコピーされました

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

例

1
2
3


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

レスポンス

固定リンクがコピーされました

なし

エラー

固定リンクがコピーされました

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

Garoon API

Garoon APIドキュメント

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

目次

コメントを取得する

API名

利用できるバージョン

リクエスト

例

レスポンス

例

エラー

コメントを追加する

API名

利用できるバージョン

リクエスト

例

レスポンス

例

エラー

コメントを削除する

API名

利用できるバージョン

リクエスト

例

レスポンス

エラー