填写记录的回复
指定应用ID和记录编号可填写记录的回复。
如果使用的是API令牌,那么填写回复的用户为“Administrator”。
被@的人的名字按照填写人设置的语言来显示。
停用的用户、已被删除的用户/组织/组不会收到通知。
如果是来宾空间,已经退出空间的用户的处理和已删除用户一样。
@给正在邀请中的来宾用户时会报错。
禁用了记录的回复功能时,执行该API会报错。
HTTP 方法
POST
URI
https://(子域名).cybozu.cn/k/v1/record/comment.json
来宾空间内的应用
https://(子域名).cybozu.cn/k/guest/(空间的ID)/v1/record/comment.json
必要的访问权限
要填写回复的应用的查看权限
要填写回复的记录的查看权限
请求参数
参数名称 | 要指定的值 | 必须 | 说明 |
---|---|---|---|
app | 数值或字符串 | 必须 | 指定应用的ID。 |
record | 数值或字符串 | 必须 | 指定记录编号。 |
comment | 对象 | 必须 | 回复的信息。 |
comment.text | 字符串 | 必须 | 回复的内容。 回复的字数最多为65535个字符。 |
comment.mentions | 数组 | 被@的对象的信息。 | |
comment.mentions[].code | 字符串 | 被@的用户/组织/组的代码。 最多可以有10个@。 指定@时,正文的前面会插入@对象。 ※如@给来宾用户,code指定为:[guest/登录名] | |
comment.mentions[].type | 字符串 | 被@的用户/组织/组的类型。
|
请求的范例
包含请求头部的字符串
POST /k/v1/record/comment.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": 12343, "record": 4, "comment": { "text": "来自应用管理员的通知。\n请确认。", "mentions": [ { "code": "zhou", "type": "USER" }, { //为目标用户指定来宾用户时 "code": "guest/zhou@test.jp", "type": "USER" }, { "code": "市场部", "type": "ORGANIZATION" }, { "code": "devnet运营组", "type": "GROUP" } ] } }
应答
返回填写成功的回复的ID。
{"id": 3}
JavaScript范例
使用API请求发送 kintone REST API 请求
var body = { "app": 1, "record": 1001, "comment": { "text": "来自应用管理员的通知。\n请确认。", "mentions": [ { "code": "zhou", "type": "USER" }, { //为目标用户指定来宾用户时 "code": "guest/zhou@test.jp", "type": "USER" }, { "code": "市场部", "type": "ORGANIZATION" }, { "code": "devnet运营部", "type": "GROUP" } ] } } kintone.api(kintone.api.url('/k/v1/record/comment', true), 'POST', body, function(resp) { //success console.log(resp); }, function(error) { //error console.log(error); });
使用 XMLHttpRequest 请求
var body = { "app": 1, "record": 1001, "comment": { "text": "来自应用管理员的通知。\n请确认。", "mentions": [ { "code": "zhou", "type": "USER" }, { //为目标用户指定来宾用户时 "code": "guest/zhou@test.jp", "type": "USER" }, { "code": "市场部", "type": "ORGANIZATION" }, { "code": "devnet运营组", "type": "GROUP" } ] }, // CSRF TOKEN: 在kintone执行API(POST, PUT, DELETE)时需要设置 "__REQUEST_TOKEN__": kintone.getRequestToken() }; var url = 'https://{subdomain}.cybozu.cn/k/v1/record/comment.json'; var xhr = new XMLHttpRequest(); xhr.open('POST', url); xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest'); xhr.setRequestHeader('Content-Type', 'application/json'); xhr.onload = function() { if (xhr.status === 200) { // success console.log(JSON.parse(xhr.responseText)); } else { // error console.log(JSON.parse(xhr.responseText)); } }; xhr.send(JSON.stringify(body));
使用API令牌填写时的范例