獲取有關空間的資訊

information

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

目錄

獲取有關空間的資訊

獲取有關空間的資訊。

  • 如果不使用空間功能,則會發生錯誤。
  • 如果關閉了訪客空間功能,則在嘗試選取訪客空間資訊時將發生錯誤。

URL

正常空間
https://sample.cybozu.com/k/v1/space.json
訪客空間
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/space.json

HTTP 方法

GET

所需存取權限

  • 查看空間的許可權
    對於非公開空間,只有空間成員才能執行它。

請求

參數
參數名稱 類型 必須 說明
id 數值或字串 必須 要選取其信息的空間的空間ID
範例請求(如果在網址中包含參數 )
URL

https://sample.cybozu.com/k/v1/space.json?id=1

標頭
1
2
3
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

關於請求標頭,請參見 kintone REST API的通用規範

範例要求(如果要在請求內文中包含參數)
URL

https://sample.cybozu.com/k/v1/space.json

標頭
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

關於請求標頭,請參見 kintone REST API的通用規範

內文
1
2
3
{
  "id": "1"
}

回應

屬性
屬性名稱 類型 說明
id 字串 空間ID
name 字串 空間名稱
defaultThread 字串 創建空間時最初建立的主題的主題ID
如果只有一個線程使用空間,則該主題是唯一的主題。
isPrivate 布爾值 公開/非公開分類
  • true: 非公開空間
  • false: 公開空間
creator 物件 空間建立人資訊
creator.code 字串 建立人的代碼
如果使用者被掛起或刪除,則返回一個空字串。
creator.name 字串 建立人的姓名
如果使用者被掛起或刪除,則返回一個空字串。
modifier 物件 空間更新人資訊
modifier.code 字串 更新人的代碼
如果使用者被掛起或刪除,則返回一個空字串。
modifier.name 字串 更新人的姓名
如果使用者被掛起或刪除,則返回一個空字串。
memberCount 字串 空間中的成員數
coverType 字串 空間封面圖片的類型
  • BLOB:上傳檔案
  • PRESET:內置圖像
coverKey 字串 空間封面圖片的鍵字串
coverUrl 字串 空間封面圖片的網址
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”。
示例回應
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{
  "id": "1",
  "name": "整個接觸空間",
  "defaultThread": "3",
  "isPrivate": true,
  "creator": {
    "code": "tanaka",
    "name": "田中太郎"
  },
  "modifier": {
    "code": "tanaka",
    "name": "田中太郎"
  },
  "memberCount": "10",
  "coverType": "PRESET",
  "coverKey": "GREEN",
  "coverUrl": "https://*******/green.jpg",
  "body": "<b>是一個完整的</b>空間。",
  "useMultiThread": true,
  "showAnnouncement": true,
  "showThreadList": true,
  "showAppList": true,
  "showMemberList": true,
  "showRelatedLinkList": true,
  "isGuest": false,
  "fixedMember": false,
  "attachedApps": [
    {
      "threadId": "1",
      "appId": "1",
      "code": "TASK",
      "name": "任務管理",
      "description": "它是一個管理任務的應用程式。",
      "createdAt": "2012-02-03T09:22:00Z",
      "creator": {
        "name": "佐藤昇",
        "code": "sato"
      },
      "modifiedAt": "2012-04-15T10:08:00Z",
      "modifier": {
        "name": "佐藤昇",
        "code": "sato"
      }
    },
    {
      "threadId": "3",
      "appId": "10",
      "code": "",
      "name": "問卷表",
      "description": "這是一個調查應用程式。",
      "createdAt": "2012-02-03T09:22:00Z",
      "creator": {
        "name": "佐藤昇",
        "code": "sato"
      },
      "modifiedAt": "2012-04-15T10:08:00Z",
      "modifier": {
        "name": "佐藤昇",
        "code": "sato"
      }
    },
    {
      "threadId": "3",
      "appId": "11",
      "code": "",
      "name": "日報",
      "description": "這是一個每日報告應用程式。",
      "createdAt": "2012-02-03T09:22:00Z",
      "creator": {
        "name": "加藤美咲",
        "code": "kato"
      },
      "modifiedAt": "2012-04-15T10:08:00Z",
      "modifier": {
        "name": "加藤美咲",
        "code": "kato"
      }
    }
  ]
}

示例代碼

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

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