删除空间

aki发表于:2019年08月16日 09:41:56更新于:2021年08月09日 16:16:16

删除空间

空间的管理员可以删除空间。

HTTP 方法

DELETE

URI

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

来宾空间

https://(子域名).cybozu.cn/k/guest/(来宾空间的ID)/v1/space.json 
※来宾用户不可执行。

必要的访问权限

空间的管理员

请求参数

参数名称要指定的值必须说明
id数值或字符串必须指定要删除的空间ID。

请求范例

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

请求头部
DELETE /k/v1/space.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
正文
{    
    "id": 1    
}
  • Content-Type里请指定application/json。如不指定,JSON 无法解析,执行时会报错。

  • JSON字符串放在请求的正文中发送。

应答

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

{}

特定条件下的动作

  • 在空间、来宾空间功能为OFF的情况下执行时,会报错。

JavaScript范例

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

var body = {    
    "id": 1001    
}    
kintone.api(kintone.api.url('/k/v1/space', true), 'DELETE', body, function(resp) {    
    // success    
    console.log(resp);    
}, function(error) {    
    // error    
    console.log(error);    
});

使用 XMLHttpRequest 请求

var body = {    
    "id": 1001,    
    // CSRF TOKEN: 从kintone里执行API(POST, PUT, DELETE)时需要设置    
    "__REQUEST_TOKEN__": kintone.getRequestToken()    
};

var url = 'https://{subdomain}.cybozu.cn/k/v1/space.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));