更新空间的主题

aki发表于:2019年08月16日 10:10:57更新于:2021年08月09日 16:22:14

更新空间的主题

更新空间或来宾空间的主题。

  • 如未使用空间的功能,将报错。

  • 如未使用来宾空间的功能,将报错。

HTTP 方法

PUT

URI

https://(子域名).cybozu.cn/k/v1/space/thread.json

来宾空间

https://(子域名).cybozu.cn/k/guest/<来宾空间的ID>/v1/space/thread.json

必要的访问权限

空间的管理员或主题创建者

请求参数

参数名称要指定的值必须说明
id数值或字符串必须指定要更新的主题ID。
name字符串
在1~128个字符内指定主题。省略时不更新。
※单个主题空间的主题因为没有名字,不进行更新。
body字符串
主题的正文须在65535个字符内,为HTML文本。不可使用的标签、属性在保存时会被删除。粘贴应用、上传附件、输入表情文字等可通过HTML来实现。但即使通过HTML来指定了提醒对象,也不会发送通知。省略时不更新。 

请求范例

以下是在HTTP请求的请求正文中设置JSON数据的范例。

请求头部
PUT /k/v1/space/thread.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
正文
{    
    "id": 1,    
    "name": "总务部联络用主题",    
    "body": "<b>用于通知一些跟</b>总务部相关的事务。"    
}
  • Content-Type里请指定application/json。如不指定,JSON 无法解析,执行时会报错。

  • JSON字符串写在请求正文里发送。

应答

处理成功时返回空的JSON数据。

{}

JavaScript范例

使用API请求发送 kintone REST API 请求

var body = {    
    "id": 1001,    
    "name": "总务部联络用主题",    
    "body": "<b>用于通知一些跟</b>总务部相关的事务。"    
}    
kintone.api(kintone.api.url('/k/v1/space/thread', true), 'PUT', body, function(resp) {    
    // success    
    console.log(resp);    
}, function(error) {    
    // error    
    console.log(error);    
});

使用 XMLHttpRequest 请求

var body = {    
    "id": 1001,    
    "name": "总务部联络用主题",    
    "body": "<b>用于通知一些跟</b>总务部相关的事务。",    
    "__REQUEST_TOKEN__": kintone.getRequestToken()    
};

var url = 'https://{subdomain}.cybozu.cn/k/v1/space/thread.json';    
var xhr = new XMLHttpRequest();    
xhr.open('PUT', 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));