获取空间的信息

获取空间的信息。

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

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

HTTP 方法

GET

URI

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

来宾空间

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

必要的访问权限

空间的查看权限

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

请求参数

请求的范例

(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": "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": "1",    
            "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();