删除记录的回复
指定应用ID和记录编号、回复ID可删除特定的记录回复。
可删除执行该API的用户自己填写的回复。
使用API令牌可删除“Administrator”填写的回复。
禁用了记录的回复功能时,执行该API会报错。
HTTP 方法
DELETE
URI
https://(子域名).cybozu.cn/k/v1/record/comment.json
来宾空间的应用
https://(子域名).cybozu.cn/k/guest/(空间ID)/v1/record/comment.json
必要的访问权限
要删除回复的应用的查看权限
要删除回复的记录的查看权限
请求参数
参数名称 | 要指定的值 | 必须 | 说明 |
---|---|---|---|
app | 数值或字符串 | 必须 | 指定应用ID。 |
record | 数值或字符串 | 必须 | 指定记录编号。 |
comment | 数值或字符串 | 必须 | 指定回复ID。 |
请求的范例
使用HTTP的查询字符串发送参数时
使用“&”将请求参数连起来并对URL进行编译后,作为HTTP的查询字符串发送。
查询字符串
app=1&record=1&comment=1
包含请求头部的字符串
DELETE /k/v1/record/comment.json? app%3D1%26record%3D1%26comment%3D1 HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type头部不需要。
使用JSON数据发送参数时
JSON数据写在HTTP请求的请求正文中时的范例如下。
包含请求头部的字符串
DELETE /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": 1, "record": 1, "comment": 1 }
应答
参数
无
应答的范例
处理成功时返回空的JSON数据。
{ }
JavaScript范例
使用API请求发送 kintone REST API 请求
var body = { "app": 1, "record": 1001, "comment": 1 }; kintone.api(kintone.api.url('/k/v1/record/comment', true), 'DELETE', body, function(resp) { //success console.log(resp); }, function(error) { //error console.log(error); });
使用 XMLHttpRequest 请求
var body = { "app": 1, "record": 1001, "comment": 1, // 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('DELETE', 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));
限制事项
请参考REST API共通规格的限制事项 。