
# 查询组织列表
#### 功能介绍
应用服务器可调用此接口查询组织列表。
需要注意：
- 通过填写字段parent_id以查询指定父级组织的子组织节点。
  
- 如果不填写parent_id字段，则该字段将被置为null，意味着查询根节点。
  
 
#### URI
GET /v1/iotfm/organizations
表1Query参数 
| 参数        | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| parent_id | 否    | String  | **参数说明**：父级组织ID。如不填写该参数，则默认返回首层区域列表。 **取值范围**：长度固定24，只允许大小写字母、数字的组合。                                                                                                                                                                 |
| limit     | 否    | Integer | **参数说明**：分页查询时每页显示的记录数。 **取值范围**：默认值为10，取值范围为1-50的整数。                                                                                                                                                                                 |
| marker    | 否    | String  | **参数说明**：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 **取值范围**：长度固定24，只允许大小写字母、数组的组合。 |
   
#### 请求参数
表2请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                              |
|:---|:---|:---|:---|
| X-Auth-Token  | 是    | String | **参数说明** ：用户Token。通过调用 [生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html) 接口获取，接口返回的响应消息头中"X-Subject-Token"就是需要获取的用户Token。 |
| X-Instance-Id | 是    | String | **参数说明**：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。 **取值范围**：长度8-36，只允许大小写字母、数字和-字符的组合。            |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数            | 参数类型                                                                                                                | 描述                                                                      |
|:---|:---|:---|
| organizations | Array of [OrganizationItem] objects | **参数说明**：组织列表。 **取值范围**：长度0-50。 |
| page          | [Page] object                                   | 查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大ID。                                 |
   
 表4OrganizationItem 
| 参数             | 参数类型                 | 描述                                                                                                     |
|:---|:---|:---|
| id             | String               | **参数说明**：组织ID。 **取值范围**：长度固定24，只允许大小写字母、数字的组合。                  |
| name           | String               | **参数说明**：组织名。 **取值范围**：长度1-256。                                  |
| parent_id      | String               | **参数说明**：父级组织ID。 **取值范围**：长度固定24，只允许大小写字母、数字的组合。                 |
| children_count | Integer              | **参数说明**：直接下级数量。 **取值范围**：大小为0-100。                            |
| properties     | Map\<String,String\> | **参数说明**：属性键值对。                                                                                        |
| create_time    | String               | **参数说明**：创建时间，格式为：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'。 **取值范围**：长度0-20。 |
   
 表5Page 
| 参数     | 参数类型   | 描述                                                                                                 |
|:---|:---|:---|
| count  | Long   | **参数说明**：本次分页查询结果中，获取的记录总数。                                                                        |
| marker | String | **参数说明**：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。 **取值范围**：长度0-64。 |
   
**状态码：400**
表6响应Body参数 
| 参数         | 参数类型   | 描述                                                                      |
|:---|:---|:---|
| error_code | String | **参数说明**：错误码。 **取值范围**：长度8-36。   |
| error_msg  | String | **参数说明**：错误描述。 **取值范围**：长度2-512。 |
   
#### 请求示例
查询组织列表
```
GET https://{endpoint}/v1/iotfm/organizations
```
#### 响应示例
**状态码：200**
Organization Information
```
{
  "organizations" : [ {
    "name" : "DemoOrg0",
    "id" : "abcdefaaaaaaaaaaaaaaaaaaaa"
  }, {
    "name" : "DemoOrg1",
    "id" : "abcdefaaaaaaaaaaaaaaaaaaab"
  }, {
    "name" : "DemoOrg2",
    "id" : "abcdefaaaaaaaaaaaaaaaaaaac"
  }, {
    "name" : "DemoOrg3",
    "id" : "abcdefaaaaaaaaaaaaaaaaaaad"
  } ],
  "page" : {
    "count" : 4,
    "marker" : "abcdefaaaaaaaaaaaaaaaaaaad"
  }
}
```
#### 状态码
| 状态码 | 描述                       |
|:---|:---|
| 200 | Organization Information |
| 400 | Error response           |
   
