接口功能介绍
查询部门列表
接口约束
无
URI
GET /v3/org/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| parentOrgOid | 否 | String | 上级部门ID，不填则返回根部门 | org-adhij4zha35v3knu9irlg | |
| orgName | 否 | String | 部门名称 | abctest | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 100 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ||
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | { } | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | ||
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| orgOid | String | 部门ID | ||
| orgName | String | 部门名称 | ||
| description | String | 部门描述 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"orgOid":"org-foo","orgName":"foo","description":"foo"}]}}
状态码
请参考 状态码
错误码
请参考 错误码
