批量获取记录的回复
指定应用ID和记录编号即可批量获取记录的回复。
一次最多可获取10条回复.
如果禁用了记录的回复功能，执行该API时将报错。
HTTP 方法
GET
URI
https://(子域名).cybozu.cn/k/v1/record/comments.json
来宾空间内的应用
https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/record/comments.json
必要的访问权限
要获取回复的应用的查看权限
要获取回复的记录的查看权限
请求参数
| 参数名称 | 要指定的值 | 必须 | 说明 |
|---|---|---|---|
| app | 数值或字符串 | 必须 | 指定应用ID。 |
| record | 数值或字符串 | 必须 | 指定记录编号。 |
| order | 字符串 | 可省略 | 可对回复的ID进行排序。 指定“asc”时为升序，指定“desc”时为降序。 省略时为"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.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type头部不需要。
使用JSON数据发送参数时
JSON数据写在HTTP请求的请求正文中时：
包含请求头部的字符串
GET /k/v1/record/comments.json HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
请在Content-Type中指定application/json。如不指定，JSON无法识别，执行时将报错。
正文
{
"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 | 字符串 | 被@的用户/组织/组的类型。
|
| older | 布尔值 | 判断是否存在比获取到的回复ID还要早的回复。
|
| newer | 布尔值 | 判断是否存在比获取到的回复ID更晚的回复。
|
应答的范例
页面
应答
{
"comments": [
{
"id": "2",
"text": "aki \n确认了，没有问题。\n请继续加油。",
"createdAt": "2017-11-15T11:54:00Z",
"creator": {
"code": "zhou",
"name": "周世杰"
},
"mentions": [
{
"code": "aki",
"type": "USER"
}
]
},
{
"id": "1",
"text": "陈飞 市场部\n这是今天的进展程度。\n周世杰 请确认。",
"createdAt": "2017-11-15T11:53:00Z",
"creator": {
"code": "aki",
"name": "aki"
},
"mentions": [
{
"code": "chenfei",
"type": "USER"
},
{
"code": "市场部",
"type": "ORGANIZATION"
},
{
"code": "zhou",
"type": "USER"
}
]
}
],
"older": false,
"newer": false
}JavaScript范例
使用API请求发送 kintone REST API 请求
var body = {
"app": 1,
"record": 1001
};
kintone.api(kintone.api.url('/k/v1/record/comments', true), 'GET', body, function(resp) {
// success
console.log(resp);
}, function(error) {
// error
console.log(error);
});使用 XMLHttpRequest 请求
var params = '?app=1&record=1001';
var url = 'https://{subdomain}.cybozu.cn/k/v1/record/comments.json' + params;
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
if (xhr.status === 200) {
// success
console.log(JSON.parse(xhr.responseText));
} else {
// error
console.log(JSON.parse(xhr.responseText));
}
};
xhr.send();限制事项
请参考REST API共通规格的限制事项 。