查詢空間的詳細信息。

路徑 /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