Garoon APIドキュメント

ディスカッションを作成する

目次

ディスカッションを作成する

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

ディスカッションを作成します。

URL

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

クラウド版

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

パスパラメーター
パラメーター名 説明
SPACE_ID ディスカッションを作成するスペースのID

HTTPメソッド

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

POST

利用できるバージョン

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

  • クラウド版Garoon

リクエスト

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

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

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

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

ボディ
1
2
3
4
5

{
  "title": "Discussion 1",
  "body": "This is discussion body.",
  "isHtmlBody": true
}

レスポンス

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

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

{
  "id": "1",
  "title": "Discussion 1",
  "body": "This is discussion body.",
  "isHtmlBody": true
}

サンプルコード

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

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

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

const body = {
  title: 'Discussion 1',
  body: 'This is discussion body.',
  isHtmlBody: true
};

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