獲取項目下全部的空間基礎信息

路徑 /campus/paas/openapi/space/list
版本號 1.1.1
協議 HTTPS
請求方法 POST
是否需要用戶身份鑒權 否
超時時間 3000

請求參數

名稱 類型 是否必選 示例值 描述
appId String 是 d64ff*****134e8d9bf40a16065d59b3 應用實例唯一id
pageNo Int 是 1 當前頁碼
pageSize Int 是 1 每頁條數
filter Struct 是 空間篩選信息
parentSpaceId String 否 空間位置id（二級空間節點id）
usageCode String 否 空間用途，可通過空間用途接口查詢

返回數據

名稱 類型 示例值 描述
code Int

響應碼, 200: 成功
message String

錯誤消息
localizedMsg String

本地語言錯誤消息
data JSON

返回結果數據
total Long

總條數
pageNo Int

當前頁碼
pageSize Int

每頁條數
data JSON

結果集合
name String

空間名稱
namePath String

空間層級結構
usage String

空間用途名稱
hasChild Boolean

是否含有子空間
description String

空間描述
spaceId String

空間id
usageCode String

空間用途code

示例

請求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.1.1"
	},
	"params":{
		"appId": "d64ff*****134e8d9bf40a16065d59b3",
		"pageNo":1,
		"pageSize":1,
		"filter": "value3"
	}
}

正常返回示例

JSON 格式 

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "data": [
            {
                "description": "",
                "hasChild": true,
                "name": "xxxxx*****",
                "namePath": "/xxxxx*****/xxxxx*****/",
                "usesName": "寫字樓",
                "spaceId": "xx****",
                "usageCode": "xx****"
            },
            {
                "description": "",
                "hasChild": false,
                "name": "xxxxxxxxxx",
                "namePath": "/xxxxx*****/xxxxx*****/xxxxx*****/",
                "usesName": "寫字樓",
                "spaceId": "xx****",
                "usageCode": "xx****"
            }
        ],
        "pageNo": 1,
        "pageSize": 20,
        "total": 100
    }
}

異常返回示例

JSON 格式 

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 28402,
    "message": "no access to the project",
    "localizedMsg": "無權訪問該項目",
    "data": null
}

錯誤碼

HttpCode 錯誤碼 錯誤信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
200 2459 oa error message 會話Id不存在
200 2459 oa error message 會話Id不存在
200 2401 refreshToken invalid refreshToken已經失效
200 2401 refreshToken invalid refreshToken已經失效
200 460 identityIds need between 1-50 入參錯誤
200 460 identityIds need between 1-50 入參錯誤
200 460 identityIds need between 1-50 入參錯誤
200 460 identityIds need between 1-50 入參錯誤
200 403 request forbidden. 請求被禁止
200 2407 openId invalid openId invalid
200 403 request forbidden. 請求被禁止
200 2407 openId invalid openId invalid
200 403 request forbidden. 請求被禁止
200 2407 openId invalid openId invalid
200 403 request forbidden. 請求被禁止