获取空间的信息

aki发表于:2019年08月16日 09:39:01更新于:2021年08月25日 16:12:02

获取空间的信息

获取空间的信息。

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

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

HTTP 方法

GET

URI

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

来宾空间

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

必要的访问权限

空间的查看权限

※为非公开的空间时,仅空间的成员可执行。

请求参数

参数名称要指定的值必须说明
id数值或字符串必须指定要获取信息的空间ID。

请求的范例

(1) 用HTTP的查询字符串发送参数时

“id”的参数作为HTTP的查询字符串发送。

包含请求头部的字符串
 GET /k/v1/space.json?id=1 HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Type头部不需要。

(2) 以JSON形式发送参数时(在HTTP请求的请求正文中设置JSON数据时)

请求头部
GET /k/v1/space.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 无法解析,执行时会报错。

正文
{    
    "id": "1"    
}
  • JSON字符串放在请求正文中发送。

应答

参数名称值的类型说明
id字符串空间ID。
name字符串空间名称。
defaultThread字符串创建空间时默认生成的主题ID。在单主题空间里,仅存在此主题。
isPrivate布尔值公开、非公开的区分。
true: 非公开空间
false: 公开空间
creator对象空间的创建人信息。
creator.code字符串创建人的代码。如果是停用或已删除的用户,返回空字符串。
creator.name字符串创建人的名字。如果是停用或已删除的用户,返回空字符串。
modifier对象空间的更新人的信息。
modifier.code字符串更新人的代码。如果是停用或已删除的用户,返回空字符串。
modifier.name字符串更新人的名字。如果是停用或已删除的用户,返回空字符串。
memberCount字符串空间的成员数。
coverType字符串空间的背景图片的类型。 BLOB: 上传的文件 PRESET: 嵌入的图片
coverKey字符串空间的背景图片的key。
coverUrl字符串空间的背景图片的URL。
body字符串空间的正文(HTML)。
若空间正文中的 HTML 为空,则返回 null。
若一旦设置过空间正文,即使只设置过 HTML 头部,画面上没有显示任何内容的情况下,则返回这些字符串。
useMultiThread布尔值判断是否为多主题空间。
true: 多主题空间
false: 单主题空间
isGuest布尔值判断是否为来宾空间。
true: 来宾空间
false: 普通空间
attachedApps数组主题内的应用的列表。不包含未公开的应用。未设置完成的项目也未反映到应用。
attachedApps[].threadId字符串主题ID。
attachedApps[].appId字符串应用ID。
attachedApps[].code字符串应用代码。未指定时返回空间的字符串。
attachedApps[].name字符串应用的名字。对应了多国语言时,返回其结果。
attachedApps[].description字符串应用的说明。对应了多国语言时,返回其结果。
attachedApps[].createdAt字符串应用的创建时间。
attachedApps[].creator对象应用的创建人信息。
attachedApps[].creator.code字符串创建人的代码。如果是停用或已删除的用户,返回空字符串。
attachedApps[].creator.name字符串创建人的名字。如果是停用或已删除的用户,返回空字符串。
attachedApps[].modifiedAt字符串应用的更新时间。
attachedApps[].modifier对象应用的更新人信息。
attachedApps[].modifier.code字符串更新人的代码。如果是停用或已删除的用户,返回空字符串。
attachedApps[].modifier.name字符串更新人的名字。如果是停用或已删除的用户,返回空字符串。
fixedMember布尔值判断是否禁止各用户擅自退出空间或解除关注。
true: 禁止
false: 不禁止
showAnnouncement布尔值启用了"使用空间门户和多主题"的空间门户的"公告"显示状态。
true: 显示
false: 不显示
※ 仅使用一个主题的空间·来宾空间的值为 null
showThreadList布尔值启用了"使用空间门户和多主题"的空间门户的"主题列表"显示状态。                
true: 显示
false: 不显示
※ 仅使用一个主题的空间·来宾空间的值为 null
showAppList布尔值启用了"使用空间门户和多主题"的空间门户的"应用列表"显示状态。
true: 显示
false: 不显示
※ 仅使用一个主题的空间·来宾空间的值为 null
showMemberList布尔值启用了"使用空间门户和多主题"的空间门户的"用户列表"显示状态。
true: 显示
false: 不显示
※ 仅使用一个主题的空间·来宾空间的值为 null
showRelatedLinkList布尔值启用了"使用空间门户和多主题"的空间门户的"关联链接列表"显示状态。
true: 显示
false: 不显示
※ 仅使用一个主题的空间·来宾空间的值为 null
{    
    "id": "1",    
    "name": "全公司通知",    
    "defaultThread": "3",    
    "isPrivate": true,    
    "creator": {    
        "code": "zhang",    
        "name": "张恺"    
    },    
    "modifier": {    
        "code": "zhang",    
        "name": "张恺"    
    },    
    "memberCount": 10,    
    "coverType": "PRESET",    
    "coverKey": "GREEN",    
    "coverUrl": "https://*******/green.jpg",    
    "body": "发布全公司<b>通知</b>的空间。",    
    "useMultiThread": true,    
    "isGuest": false,    
    "attachedApps": [    
        {    
            "threadId": "1",    
            "appId": "1",    
            "code": "TASK",    
            "name": "任务管理",    
            "description": "用于管理任务的应用。",    
            "createdAt": "2012-02-03T09:22:00Z",    
            "creator": {    
                "name": "李好",    
                "code": "li"    
            },    
            "modifiedAt": "2012-04-15T10:08:00Z",    
            "modifier": {    
                "name": "李好",    
                "code": "li"    
            }    
        },    
        {    
            "threadId": "3",    
            "appId": "10",    
            "code": "",    
            "name": "问卷调查表",    
            "description": "用于问卷调查的应用。",    
            "createdAt": "2012-02-03T09:22:00Z",    
            "creator": {    
                "name": "李好",    
                "code": "li"    
            },    
            "modifiedAt": "2012-04-15T10:08:00Z",    
            "modifier": {    
                "name": "李好",    
                "code": "li"    
            }    
        },    
        {    
            "threadId": "3",    
            "appId": "11",    
            "code": "",    
            "name": "日报",    
            "description": "日报应用。",    
            "createdAt": "2012-02-03T09:22:00Z",    
            "creator": {    
                "name": "陈飞",    
                "code": "chen"    
            },    
            "modifiedAt": "2012-04-15T10:08:00Z",    
            "modifier": {    
                "name": "陈飞",    
                "code": "chen"    
            }    
        }    
    ]    
}

JavaScript范例

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

var body = {    
    "id": 1    
};

kintone.api(kintone.api.url('/k/v1/space', true), 'GET', body, function(resp) {    
    // success    
    console.log(resp);    
}, function(error) {    
    // error    
    console.log(error);    
});

使用 XMLHttpRequest 请求

var url = 'https://{subdomain}.cybozu.cn/k/v1/space.json?id=1';

var xhr = new XMLHttpRequest();    
xhr.open('GET', url);    
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');    
xhr.onload = function() {    
    if (xhr.status === 200) {    
        // success    
        console.log(JSON.parse(xhr.responseText));    
    } else {    
        // error    
        console.log(JSON.parse(xhr.responseText));    
    }    
};    
xhr.send();