レコードコメントを取得する
レコードのコメントを取得します。
- 一度に取得できるコメントは 10 件までです。
- レコードのコメント機能を無効にしたアプリで実行すると、エラーになります。
URL
- 通常のアプリ
- https://sample.cybozu.com/k/v1/record/comments.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/record/comments.json
HTTP メソッド
GET
必要なアクセス権
- コメントを取得するアプリの閲覧権限
- コメントを取得するレコードの閲覧権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
app | 数値または文字列 | 必須 | アプリ ID |
record | 数値または文字列 | 必須 | レコード ID |
order | 文字列 | 省略可 | 取得するコメントの並び順
|
offset | 数値 | 省略可 | 取得するコメントの先頭からスキップする数 省略すると、0 が設定されます。 |
limit | 数値 | 省略可 | 取得するコメント数の上限 0 から 10 までの数値を指定できます。 省略すると、 10 が設定されます。 |
リクエストの例 (URL にパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/record/comments.json?app=1&record=1
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
リクエストの例 (リクエストボディにパラメーターを含める場合)
URL
https://sample.cybozu.com/k/v1/record/comments.json
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
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 より後のコメントがあるかどうか
|
レスポンスの例
|
|
サンプルコード
curl を使ったリクエスト
|
|
kintone REST APIリクエストを送信する API を使ったリクエスト
|
|