소스 검색

添加返回值格式,支持按公司或部门查询人员

wudla 4 년 전
부모
커밋
0e09307cb7
2개의 변경된 파일48개의 추가작업 그리고 35개의 파일을 삭제
  1. 24 35
      docs/org/org_api.md
  2. 24 0
      docs/utils/query.md

+ 24 - 35
docs/org/org_api.md

@@ -2,13 +2,27 @@
 
 ## 系统接口
 
-> #### (注:condition 为 query,create,update,delete)
+> #### 1、condition 为 query,create,update,delete
 >
-> #### (注:为了读写分离,serviceid还会变动,请不要写死
+> #### 2、为了读写分离,serviceid还会变动,请不要写死
 >
-> #### (注:userId、groupCode、projectId必须传值,appId可以为空
+> #### 3、userId、groupCode、projectId必须传值,appId可以为空
 >
-> #### 请求方式:POST
+> #### 4、请求方式:POST
+>
+> #### 5、create,update,delete 返回值格式
+>
+> ```json
+> {
+>     "result": "success",
+>     "data": {
+>         "ids": [
+>             "5c1e17",
+>             "727591"
+>         ]
+>     }
+> }
+> ```
 
 ### 查询
 
@@ -147,9 +161,13 @@
   "createTime": 1602635430000,
   "updateUser": "1",
   "updateTime": 1602641567000,
-  "remark": "测试数据"
+  "remark": "测试数据",
+  "companyIds": ["",""],
+  "deptIds": ["",""],
 }
+支持用companyIds或deptIds查询人员,companyIds与deptIds同时传值,取companyIds自动忽略deptIds
 "withColumns" 可用字段 "jobs"
+
 新增:[{},{}]
 [
   {
@@ -396,7 +414,7 @@
 ]
 ```
 
-### 应用
+### 应用(只提供查询接口)
 
 请求路径:/application/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -421,35 +439,6 @@
   "updateTime": 1602638597000,
   "remark": "测试数据"
 }
-新增:[{},{}]
-[{
-  "code": "DMP",//非空
-  "name": "数据中台",//非空
-  "category": "运维",//非空
-  "appOrder": 1,//非空
-  "menuIconKey": "test_icon",
-  "iconKey": "test_key",
-  "description": "测试des",
-  "objType": "test_type",
-  "remark": "测试数据"
-}]
-更新:
-[{
-  "id": "1",//非空
-  "code": "DMP",//非空
-  "name": "数据中台",//非空
-  "category": "运维",//非空
-  "appOrder": 1,//非空
-  "menuIconKey": "test_icon",
-  "iconKey": "test_key",
-  "description": "测试des",
-  "objType": "test_type",
-  "remark": "测试数据"
-}]
-删除:
-[{
-  "id": "1"
-}]
 ```
 ### 功能
 

+ 24 - 0
docs/utils/query.md

@@ -20,6 +20,30 @@
 }  
 ```
 
+返回格式
+
+```json
+{
+    "result": "success",
+    "data": [
+        {
+            "id": "dev_1",
+            "groupCode": "PG",
+            "type": "major",
+            "name": "专业",
+            "description": "Testing",
+            "status": 1,
+            "createTime": 1602434380000,
+            "createUser": "wdl",
+            "updateTime": 1602705427000,
+            "updateUser": "wdl",
+            "remark": "Testing"
+        }
+    ],
+    "count": 1
+}
+```
+
 参数说明
 
 | 字段        |          | 说明                      |