查询组织信息

更新时间：2023-07-06 08:23:41下载pdf

本文介绍查询组织信息的 API。

接口描述

分页查询组织对象信息。

接口地址

POST: /v1.0/iot-03/idaas/spaces/{space_id}/organizations/actions/query

请求参数

参数名	类型	参数位置	是否必填	说明
space_id	String	uri	true	隔离空间 ID

body 说明

参数名	类型	参数位置	是否必填	说明
code	String	body	false	组织标识
codes	List	body	false	组织标识集合
name	String	body	false	组织名称
parent_code	String	body	false	父组织标识
remark	String	body	false	组织备注
status	Integer	body	false	是否启用， 0：启用，1：未启用
page_number	Integer	body	false	当前页码
page_size	Integer	body	false	每页容量

codes 说明

参数名	类型	参数位置	是否必填	说明
code	String	body	false	组织标识

返回参数

参数名	类型	说明
result	Page	分页结果集，包含当前页码，每页容量，总页数，总条数以及具体的数据

result 说明

参数名	类型	说明
total_count	Integer	总数量
total_pages	Integer	总页数
page_number	Integer	当前页码
page_size	Integer	每页容量
results	IdaasOrganizationVO	结果集

results 说明

参数名	类型	说明
code	String	组织标识
name	String	组织名称
parent_code	String	父组织标识
owner_uid	String	组织管理者标识
space_id	String	空间 ID
status	Integer	是否启用 0:启用 1:未启用
remark	String	组织标识

请求示例

POST: /v1.0/iot-03/idaas/spaces/1400335346549391440/organizations/actions/query

{
  "page_number": 10,
  "page_size": 20,
  "code": "1400335346598629930"
}

返回示例

{
    "result": {
        "total_count": 1,
        "total_pages": 1,
        "page_number": 1,
        "results": [
            {
                "gmt_create": "1622775600000",
                "parent_name": "testParentOrgName",
                "code": "1400335346598629930",
                "remark": "testRemark",
                "gmt_modified": "1622775600000",
                "owner_uid": "1400335346599528750",
                "name": "testOrgName",
                "parent_code": "1400335346598629666",
                "space_id": "1400727198159081506",
                "status": 0
            }
        ],
        "page_size": 20
    },
    "t": 1629272469492,
    "success": true
}

错误码

参考错误码。