查詢部門列表v3
更新時間 2024-06-04 11:00:44
最近更新時間: 2024-06-04 11:00:44
分享文章
接口功能介紹
查詢部門列表
接口約束
無
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"}]}}
狀態碼
請參考
錯誤碼
請參考
