Garoon APIドキュメント

コメントを作成する

目次

コメントを作成する

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

ディスカッションのコメントを作成します。

URL

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

クラウド版

https://sample.cybozu.com/g/api/v1/space/SPACE_ID/discussions/DISCUSSION_ID/comments

パスパラメーター
パラメーター名 説明
SPACE_ID 対象のスペースのID
DISCUSSION_ID コメントを追加するディスカッションのID

HTTPメソッド

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

POST

利用できるバージョン

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

  • クラウド版Garoon

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
body 文字列 必須 コメントの本文
空文字の場合、本文のないコメントが作成される
isHtmlBody 真偽値 省略可 本文を書式編集（HTML形式）で保存するかどうか
  • true：HTML形式
  • false：プレーンテキスト
省略すると「false」が設定されます。
リクエストの例
ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。

ボディ
1
2
3
4

{
   "body": "This is a comment body",
   "isHtmlBody": true
}

レスポンス

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

プロパティ
プロパティ名 型 説明
id 文字列 コメントのID
spaceId 文字列 スペースのID
discussionId 文字列 ディスカッションのID
body 文字列 コメントの本文
isHtmlBody 真偽値 本文を書式編集（HTML形式）で保存するかどうか
  • true：HTML形式
  • false：プレーンテキスト
レスポンスの例
1
2
3
4
5
6
7

{
  "id": "1",
  "spaceId": "1",
  "discussionId": "1",
  "body": "This is comment body.",
  "isHtmlBody": true
}

サンプルコード

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

curlを使ったリクエスト
1
2
3
4
5
6
7

curl -X POST 'https://sample.cybozu.com/g/api/v1/space/1/discussions/1/comments' \      
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
     "body": "This is a comment body",
     "isHtmlBody": true
    }'
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
1
2
3
4
5
6

const body = {
  body: 'This is a comment body',
  isHtmlBody: false
};

await garoon.api('/api/v1/space/1/discussions/1/comments', 'POST', body);