獲取記錄回覆

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

獲取記錄回覆

獲取記錄的回覆。

  • 您一次最多可以選取10條回覆。
  • 如果您在禁用記錄回覆的應用程式中運行它,則會出現錯誤。

URL

常規應用程式
https://sample.cybozu.com/k/v1/record/comments.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_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);