取得記錄的回覆

連結已複製

獲取記錄的回覆。

HTTP 方法	GET
URL	https://sample.cybozu.com/k/v1/record/comments.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/record/comments.json
認證	密碼驗證 , API令牌認證 , 會話認證 , OAuth認證
Content-Type	application/json（在URL中指定參數時不需指定此項）

請求參數

連結已複製

參數名稱	類型	必須	說明
app	數值或字串	必須	應用ID
record	數值或字串	必須	記錄ID
order	字串	可省略	對要獲取的回覆進行排序 `asc`：回覆ID的升序 `desc`：回覆ID的降序如果省略，則設置「desc」。
offset	數值	可省略	從一開始就跳過的回覆數如果省略，則設置為0。
limit	數值	可省略	要獲取的最大回覆數您可以指定一個介於 0 和 10 之間的數值。如果省略，則設置為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`：無回覆

所需存取權限

連結已複製

獲得回覆的應用的查看權限
獲得其回覆的記錄的查看權限

範例

連結已複製

請求範例

請求URL（在URL中包含參數的情況）

1

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

請求標頭（在URL中包含參數的情況）

1
2
3


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

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規格

請求URL（在請求主體中包含參數的情況）

1

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
}

範例回應

 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
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送kintone REST 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);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

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
  }'

補充

連結已複製

您一次最多可以選取10條回覆。
如果您在禁用記錄回覆的應用程式中運行它，則會出現錯誤。
「GET」請求最常見的方式是「在URL中指定參數」。
其他請求方法及詳情，請參閱以下頁面。
在 REST API 中使用 GET 的三種方法及其使用方法

kintone API

kintone API文件

取得記錄的回覆

目錄

請求參數

應答屬性

所需存取權限

範例

補充