更新来宾空间的来宾成员

aki发表于:2019年08月16日 10:23:57更新于:2021年08月10日 16:41:28

对所指定的来宾空间内的来宾成员进行覆盖更新。

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

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

  • 在成员更新之前,需要使用批量添加来宾用户API 先添加来宾用户。

HTTP 方法

PUT

URI

https://(子域名).cybozu.cn/k/guest/<来宾用户的ID>/v1/space/guests.json

必要的访问权限

空间的管理员

请求参数

参数名称要指定的值必须说明
id数值或字符串必须指定要更新来宾成员的来宾空间ID。
guests数组必须用数组形式指定所属来宾成员的登录名(邮箱地址)。
※如指定kintone的非来宾用户、停止使用的用户、已删除的用户时,将报错。

请求范例

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

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

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

应答

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

{}

JavaScript范例

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

var body = {    
    "id": 1001,    
    "guests": [    
        "guest1@example.com",    
        "guest2@example.com",    
        "guest3@example.com"    
    ]    
}    
kintone.api(kintone.api.url('/k/guest/{guestspaceId}/v1/space/guests', false), 'PUT', body, function(resp) {    
    // success    
    console.log(resp);    
}, function(error) {    
    // error    
    console.log(error);    
});

使用 XMLHttpRequest 请求

var body = {    
    "id": 1001,    
    "guests": [    
        "guest1@example.com",    
        "guest2@example.com",    
        "guest3@example.com"    
    ],    
    // CSRF TOKEN: 从kintone上执行API(POST, PUT, DELETE)时需要设置    
    "__REQUEST_TOKEN__": kintone.getRequestToken()    
}

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