空间查询接口,支持根据父空间查询子空间,根据空间名称、设备名称、资产编号、人员工号条件查询。

路径 /campuslink/iwms/space/query
版本号 1.0.0
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 10000

请求参数

名称 类型 是否必选 示例值 描述
spaceQuery Struct 空间查询条件对象
currentPage Int 当前分页页码
limit Int 分页大小
parentSpaceId String 父空间编号
spaceName String 空间名称
deviceName String 设备名称
jobNumber String 人员工号
orgAssetId String 资产编号

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

currentPage Int

当前分页页码

limit Int

分页大小

total Int

数据总条数

data JSON

分页数据

businessId String

业务编号

centerCoordinates String

中心点坐标

color String

空间颜色

hasChild Int

是否有子空间:0:否1:是

namePath String

空间名称路径

parentId String

父空间编号

path String

空间路径

spaceId String

空间编号

spaceName String

空间名称

status Int

空间状态:0:空闲1:占用

typeCode String

空间类型编号

useCode String

空间用途编码

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.0"
	},
	"params":{
		"spaceQuery": "value0"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "currentPage": 1, 
        "data": [
            {
                "businessId": "example", 
                "centerCoordinates": "example", 
                "color": "example", 
                "hasChild": 1, 
                "namePath": "example", 
                "parentId": "example", 
                "path": "example", 
                "spaceId": "example", 
                "spaceName": "example", 
                "status": 0, 
                "typeCode": "default", 
                "useCode": "example"
            }
        ], 
        "limit": 20, 
        "total": 0
    }
}

异常返回示例

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 460 iotToken is blank iotToken为空
200 2402 iottoken invalid iottoken已经失效
200 403 request forbidden. 请求被禁止
200 2453 app not exist appkey不存在
200 2405 identity is not existed 统一身份id不存在
200 2407 auth identity exception 不存在相应的openId
200 403 request forbidden 访问被禁止
200 460 dingdingbind employee not exist 请求参数错误
200 2442 employee is not exist 未找到绑定的员工信息
200 403 request forbidden 请求被禁止