レコードコメントの一括取得
アプリIDとレコードIDを指定してレコードのコメントを一括取得できます。
- 一度に取得できるコメントは 10件までです。
- レコードのコメント機能が無効な場合に実行するとエラーになります。
HTTP メソッド
GET
URI
https://(サブドメイン名).cybozu.com/k/v1/record/comments.json
ゲストスペース内のアプリの場合
https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/record/comments.json
必要なアクセス権
- コメントを取得するアプリの閲覧権限
- コメントを取得するレコードの閲覧権限
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| app | 数値又は文字列 | 必須 | アプリのIDを指定します。 |
| record | 数値又は文字列 | 必須 | レコードIDを指定します。 |
| order | 文字列 | 省略可 | コメントIDをソートできます。 「asc」を指定すると昇順、「desc」を指定すると降順でソートされます。 |
| offset | 数値 | 省略可 |
本オプションの後に指定した数だけ、出力するコメントをスキップして、コメントが抽出されます。 |
| limit | 数値 | 省略可 | 本オプションの後に指定した数だけ、コメントが出力されます。 "limit": 5 とした場合には、先頭から5コメントだけ出力されます。 省略時の初期値は10、上限値は10です。 |
リクエストの例
パラメータを HTTP のクエリ文字列で送信する場合
リクエストパラメータを「&」で連結し、URLエンコードしたものをHTTPのクエリ文字列として送信します。
クエリ文字列
app=1&record=1
リクエストヘッダを含んだ文字列
GET /k/v1/record/comments.json? app=1&record=1 HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
パラメータを JSON データで送信する場合
HTTPリクエストのリクエストボディに JSON データをセットする例は以下の通りです。
リクエストヘッダを含んだ文字列
GET /k/v1/record/comments.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
- Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
ボディ
レスポンス
パラメータ
| パラメータ名 | 値の種類 | 説明 |
|---|---|---|
| comments | 配列 | コメントの配列です。条件に合致するコメントがない場合には、空配列になります。 |
| comments[].id | 文字列 | コメントのIDです。 |
| comments[].text | 文字列 | コメントの文字列です。 改行が含まれると改行コードも含まれます。 コメント内にメンションがある場合、「@」が削除されて文字列に変換されます。 コメント内に繰り返しメンションされているユーザー・組織・グループは、省略されずにすべて含まれます。 |
| comments[].createdAt | 文字列 | 投稿日時です。 |
| comments[].creator | オブジェクト | 投稿者の情報です。 |
| comments[].creator.code | 文字列 | 投稿者のコードです。 |
| comments[].creator.name | 文字列 | 投稿者名です。 |
| comments[].mentions | 配列 | メンションの宛先情報です。 |
| comments[].mentions[].code | 文字列 | メンション先のユーザー・組織・グループコードです。 |
| comments[].mentions[].type | 文字列 |
メンション先のユーザー・組織・グループの種類です。
|
| older | 真偽値 |
取得したコメントIDより前のコメントがあるかどうかの情報です。
|
| newer | 真偽値 |
取得したコメントIDより後のコメントがあるかどうかの情報です。
|
レスポンスの例
画面
レスポンス
JavaScriptサンプル
XMLHttpRequest
制限事項
共通仕様の制限事項 をご確認ください。
コメントに対するいいねの数やいいねしたユーザー情報を取得するにはどうすればよいのでしょうか？
お世話になっております。cybozu developer network事務局です。
現時点では、コメントに対するいいねの数やいいねしたユーザー情報を取得するAPIはございません。
ご要望に沿えずに申し訳ございません。
引き続きcybozu developer networkよろしくお願いいたします。
お世話になります。
javaでコメントのID、投稿者等を取得することは可能でしょうか。
okka 様
お世話になっております。cybozu developer network事務局です。
「レスポンス」部分に記載があります通り、
javaでレコードコメントの一括取得APIを実行すれば、コメントのID、投稿者を取得することが出来ます。