查询空间的详细信息。
路径 | /campus/paas/openapi/space/getbyid |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
spaceId | String | 是 | 空间Id | |
appId | String | 否 | 应用Id,适用于多租户Saas应用 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
响应结果 |
|
spaceId | String |
空间id |
|
attribute | String |
空间属性 |
|
gmtCreate | Long |
创建时间 |
|
gmtModified | Long |
更新时间 |
|
parentId | String |
上级空间id |
|
businessId | String |
业务空间id |
|
name | String |
空间名称 |
|
path | String |
空间路径 /pid/pid/pid/pid/ |
|
description | String |
空间描述 |
|
typeCode | String |
空间类型代码 |
|
usesCode | String |
空间用途代码 |
|
usesName | String |
空间用途名称 |
|
typeName | String |
空间类型名称 |
|
poiCode | String |
空间编码不含父子级 |
|
poiCodePath | String |
空间编码含父子级 |
|
namePath | String |
空间路径名称 |
|
typeCodePath | String |
空间路径code ex. /building/unit/floor/house/ |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"spaceId": "value0",
"appId": "value1"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"description":"",
"gmtCreate":1570859363000,
"gmtModified":1570859373000,
"spaceId":"5a013*****5b4b83944b165380dd2674",
"name":"2级",
"namePath":"/景区测试20191011/1级/2级/",
"parentId":"370ad*****0346c09e962d67be207182",
"path":"/86465*****2c49838aeebfae8baa6a07/370ad*****0346c09e962d67be207182/5a013*****5b4b83944b165380dd2674/",
"poiCode":"D1",
"poiCodePath":"D249781-D1-D1",
"typeCode":"default",
"typeCodePath":"/default/default/default/",
"typeName":"根空间",
"usesCode":""
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"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 |