kintone API ドキュメント

レコードコメントを取得する

目次

レコードコメントを取得する

レコードのコメントを取得します。

  • 一度に取得できるコメントは 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 文字列 省略可 取得するコメントの並び順
  • asc：コメント ID の昇順
  • desc：コメント ID の降順
省略すると、「desc」が設定されます。
offset 数値 省略可 取得するコメントの先頭からスキップする数
省略すると、0 が設定されます。
limit 数値 省略可 取得するコメント数の上限
0 から 10 までの数値を指定できます。
省略すると、 10 が設定されます。
リクエストの例 （URL にパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/record/comments.json?app=1&record=1

ヘッダー
1
2
3

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

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

リクエストの例 （リクエストボディにパラメーターを含める場合）
URL

https://sample.cybozu.com/k/v1/record/comments.json

ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

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

ボディ
1
2
3
4
5
6
7

{
  "app": 1,
  "record": 1,
  "order": "desc",
  "offset": 0,
  "limit": 10
}

レスポンス

プロパティ
プロパティ名 型 説明
comments 配列 コメントの配列
条件に合致するコメントがない場合には、空配列が返ります。
comments[].id 文字列 コメント ID
comments[].text 文字列 コメントの文字列
改行が含まれると改行コードも含まれます。
コメント内に宛先を指定している場合、「@」が削除されて文字列に変換されます。
コメント内で繰り返し宛先が指定されているユーザー／組織／グループは、省略されずにすべて含まれます。
comments[].createdAt 文字列 投稿日時
comments[].creator オブジェクト 投稿者の情報
comments[].creator.code 文字列 投稿者のコード
comments[].creator.name 文字列 投稿者名
comments[].mentions 配列 宛先情報
comments[].mentions[].code 文字列 宛先のユーザー／組織／グループコード
comments[].mentions[].type 文字列 宛先のユーザー／組織／グループの種類
  • USER：ユーザー
  • GROUP：グループ
  • ORGANIZATION：組織
older 真偽値 取得したコメント ID より前のコメントがあるかどうか
  • true：以前のコメントがある
  • false：以前のコメントがない（最初のコメント）
newer 真偽値 取得したコメント ID より後のコメントがあるかどうか
  • true：以後のコメントがある
  • false：以後のコメントがない（最後のコメント）

レスポンスの例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

{
  "comments": [
    {
      "id": "2",
      "text": "佐藤　昇 \nありがとうございます。内容を確認しました。\n引き続きよろしくお願いします！",
      "createdAt": "2016-04-12T23:49:00Z",
      "creator": {
        "code": "kato",
        "name": "加藤　美咲"
      },
      "mentions": [
        {
          "code": "sato",
          "type": "USER"
        }
      ]
    },
    {
      "id": "1",
      "text": "加藤　美咲   営業本部 管理部受付 \n\n本日の作業レポートです。\n高橋　しおり さん、ご確認をお願いします。",
      "createdAt": "2016-04-12T23:46:00Z",
      "creator": {
        "code": "sato",
        "name": "佐藤　昇"
      },
      "mentions": [
        {
          "code": "kato",
          "type": "USER"
        },
        {
          "code": "営業本部_OZKQWZ",
          "type": "ORGANIZATION"
        },
        {
          "code": "管理部受付_zX6C6r",
          "type": "GROUP"
        },
        {
          "code": "takahashi",
          "type": "USER"
        }
      ]
    }
  ],
  "older": false,
  "newer": false
}

サンプルコード

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

curl -X GET 'https://sample.cybozu.com/k/v1/record/comments.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "record": 1001
  }'
kintone REST APIリクエストを送信する API を使ったリクエスト
1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  record: 1001
};

await kintone.api(kintone.api.url('/k/v1/record/comments.json', true), 'GET', body);