kintone API文件

獲取空間使用情況

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

information

此 API 僅適用於 Wide 版。
什麼是Wide 版？ (External link)

獲取空間使用情況

連結已複製

獲取空間使用情況清單。
您一次最多可以獲取 100 個應用。

URL

連結已複製

https://sample.cybozu.com/k/v1/spaces/statistics.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

無

請求

連結已複製

參數
參數名稱 類型 必須 說明
offset 數值或字串 可省略 要從要獲取的空間的開頭跳過的數量
如果省略，則設置為0。
limit 數值或字串 可省略 要獲取的數量
您可以指定一個介於 1 和 100 之間的整數。
如果省略，則設置為100。
範例請求（如果要在網址中包含參數 ）
URL

https://sample.cybozu.com/k/v1/spaces/statistics.json?offset=1&limit=1

標頭
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規範

要求範例（如果要在要求正文中包含參數）
URL

https://sample.cybozu.com/k/v1/spaces/statistics.json

標頭
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規範

正文
1
2
3
4

{
  "offset": 0,
  "limit": 1
}

回應

連結已複製

屬性
屬性名稱 類型 說明
spaces 陣列 空間使用情況清單
可以獲取的空間資訊取決於執行 API 的用戶的許可權。
  • kintone 系統管理員：所有空間
  • 常規使用者：公開空間和已加入的空間
spaces[].id 數值或字串 空間ID
spaces[].name 字串 空間名稱
spaces[].administratorCount 數值或字串 ：空間管理員數量
spaces[].memberCount 數值或字串 空間中的成員數
spaces[].isPrivate 布爾值 空間是否為非公開空間
  • true： 非公開空間
  • false： 公開空間
spaces[].isGuest 布爾值 是否訪客空間
  • true：訪客空間
  • false：常規空間
spaces[].creator 物件 空間建立人資訊
spaces[].creator.code 字串 建立人的登入名稱
即使使用者已被暫停/刪除，也可以獲取。
spaces[].creator.name 字串 作者的顯示名稱
即使使用者已被暫停/刪除，也可以獲取。
spaces[].createdAt 字串 空間的建立日期與時間
spaces[].modifier 物件 上次更新空間設置的人員的資訊
spaces[].modifier.code 字串 更新人登入名
即使使用者已被暫停/刪除，也可以獲取。
spaces[].modifier.name 字串 更新人的顯示名稱
即使使用者已被暫停/刪除，也可以獲取。
spaces[].modifiedAt 字串 上次更新空間設置的時間
示例回應
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "spaces": [
    {
      "id": "1",
      "name": "営業部",
      "administratorCount": "2",
      "memberCount": "10",
      "isPrivate": true,
      "isGuest": false,
      "creator": {
        "code": "sato-noboru",
        "name": "Sato Noboru"
      },
      "createdAt": "2023-12-04T05:45:36.000Z",
      "modifier": {
        "code": "sato-noboru",
        "name": "Sato Noboru"
      },
      "modifiedAt": "2023-12-04T05:45:36.000Z"
    }
  ]
}

示例代碼

連結已複製

使用 curl 的請求
1
2
3
4
5
6

curl -X GET 'https://sample.cybozu.com/k/v1/spaces/statistics.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit": 1
  }'
使用發送 kintone REST API 請求的 API發送請求
1
2
3
4
5

const body = {
  limit: 1
};

await kintone.api(kintone.api.url('/k/v1/spaces/statistics.json', true), 'GET', body);

限制事項

連結已複製

不能指定訪客。