空间管理

API列表

请求方式	API	描述
POST	/v1.0/osaas/projects/{project_id}/space	创建空间
PUT	/v1.0/osaas/projects/{project_id}/spaces/{space_id}	修改空间
DELETE	/v1.0/osaas/projects/{project_id}/spaces/{space_id}	删除空间
GET	/v1.0/osaas/projects/{project_id}/spaces	分页查询空间列表

创建空间

接口描述

调用该接口创建空间

接口地址

POST /v1.0/osaas/projects/{project_id}/space

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
parent_space_id	String	BODY	父空间唯一标识，不传则该空间层级为1	否
space_name	String	BODY	空间名称(最大32个字符)	是
space_type	String	BODY	空间类型编码: PARK:园区 BUILDING:楼幢 UNIT:单元 FLOOR:楼层	是
sort	Integer	BODY	排序,默认1	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	空间唯一标识

请求示例

POST {url}/v1.0/osaas/projects/1160823965053******/space

{
  "parent_space_id": "1236699939214******",
  "space_name": "5 楼",
  "space_type": "FLOOR"
}

响应成功示例

{
  "success": true,
  "result": "11123823965053******",
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

修改空间

接口描述

调用该接口修改空间

接口地址

PUT /v1.0/osaas/projects/{project_id}/spaces/{space_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	string	uri	项目唯一标识	是
space_id	string	uri	空间唯一标识	是
space_name	string	body	空间名称(最大32个字符)	否
sort	int	body	排序	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

PUT {url}/v1.0/osaas/projects/116289******/spaces/11608239650****** 

{
  "space_name": "5 楼"
}

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

删除空间

接口描述

调用该接口删除空间

接口地址

DELETE /v1.0/osaas/projects/{project_id}/spaces/{space_id}

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
space_id	String	URI	空间唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

DELETE {url}/v1.0/osaas/projects/116289******/spaces/1160823053******

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

分页查询空间列表

接口描述

调用该接口分页查询空间列表

接口地址

GET /v1.0/osaas/projects/{project_id}/spaces

请求参数

参数名	类型	参数类型	说明	是否必需
project_id	String	URI	项目唯一标识	是
parent_space_id	String	URL	父级空间唯一标识，不传查询项目下层级为1空间列表	否
page_no	Integer	URL	页码(默认为1)	否
page_size	Integer	URL	页条数(0<page_size<100，默认20)	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	返回结果

result参数说明

参数名	类型	说明
total	int	总条数
page_no	int	页码
page_size	int	页条数
spaces	Array	空间集合

spaces参数说明

参数名	类型	说明
space_id	String	空间唯一标识
space_name	String	空间名称
space_type	String	空间类型
sort	Integer	排序
gmt_create	Long	创建时间
gmt_modified	Long	修改时间

请求示例

GET {url}/v1.0/osaas/projects/116082396505******/spaces

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 100,
    "spaces": [
      {
        "space_id": "116082396505314xxxxx",
        "space_name": "5 楼",
        "space_type": "FLOOR",
        "sort": 1,
        "gmt_create": 1559707046000,
        "gmt_modified": 1559707046000
      }
    ]
  },
  "success": true,
  "t": 1561381210234
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误