获取项目下全部的空间基础信息

路径 /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. 请求被禁止