Explorar o código

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

wudla %!s(int64=4) %!d(string=hai) anos
pai
achega
36fb710b54
Modificáronse 1 ficheiros con 61 adicións e 86 borrados
  1. 61 86
      docs/org/org_api.md

+ 61 - 86
docs/org/org_api.md

@@ -2,15 +2,16 @@
 
 ## 系统接口
 
-> #### 1、condition 为 query,create,update,delete
+> #### <font color='red'>1、condition 为 query,create,update,delete</font>
 >
-> #### 2、为了读写分离,serviceid还会变动,请不要写死
+> #### <font color='red'>2、为了读写分离,serviceid还会变动,请不要写死</font>
 >
-> #### 3、userId、groupCode、projectId必须传值,appId可以为空
+> #### <font color='red'>3、增删改查userId、groupCode必须传值,projectId、appId如果有需要传</font>
 >
-> #### 4、请求方式:POST
+> #### <font color='red'>4、请求方式:POST</font>
+>
+> #### <font color='red'>5、create,update,delete 返回值格式 </font>
 >
-> #### 5、create,update,delete 返回值格式
 >
 > ```json
 > {
@@ -28,7 +29,7 @@
 
 ### [通用查询](/utils/query.md)
 
-### 集团(只提供查询接口)
+### 集团(<font color='red'>只提供查询接口</font>
 
 请求路径:/group/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -70,7 +71,7 @@
   "updateTime": 1602529764000,
   "remark": "测试数据"
 }
-"withColumns" 可用字段 "projects"
+
 新增:[{},{}]
 [{
   "code": "WD_CP_01",//非空
@@ -85,9 +86,9 @@
 更新:[{},{}]
 [{
   "id": "1",//非空
-  "code": "WD_CP_01",//非空
-  "name": "万达测试1",//非空
-  "parentId": "2",//非空
+  "code": "WD_CP_01",
+  "name": "万达测试1",
+  "parentId": "2",
   "remark": "测试数据",
   "projects": [
     {"id": "1"},
@@ -101,6 +102,8 @@
 ```
 ### 项目
 
+<font color='red'>注:项目id、name不能重复</font>
+
 请求路径:/project/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
@@ -126,7 +129,7 @@
 更新:[{},{}]
 [{
   "id": "3",//非空
-  "name": "测试项目3",//非空
+  "name": "测试项目3",
   "remark": "测试数据"
 }]
 删除:[{},{}]
@@ -136,6 +139,8 @@
 ```
 ### 人员账号
 
+<font color='red'>支持用companyIds或deptIds查询人员,companyIds与deptIds同时传值,取companyIds自动忽略deptIds,companyIds与deptIds为数组:"companyIds": ["",""]、 "deptIds": ["",""]</font>
+
 请求路径:/user/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
@@ -165,15 +170,14 @@
   "companyIds": ["",""],
   "deptIds": ["",""],
 }
-支持用companyIds或deptIds查询人员,companyIds与deptIds同时传值,取companyIds自动忽略deptIds
 "withColumns" 可用字段 "jobs"
 
 新增:[{},{}]
 [
   {
     "name": "King",
-    "username": "king",
-    "password": "123456",
+    "username": "king",//非空
+    "password": "123456",//非空
     "gender": 1,
     "phone": "13399998888",
     "mail": "test@p.com",
@@ -181,14 +185,13 @@
     "headPortrait": "test_url",
     "otherAccount": "test_other",
     "userFrom": "test_0",
-    "groupCode": "集团code",
     "isAdmin": "0",
     "remark": "测试数据"
   }
 ]
 更新:[{},{}]
 [{
-  "id": "1",
+  "id": "1",//非空
   "name": "King",
   "username": "king",
   "password": "123456",
@@ -199,7 +202,6 @@
   "headPortrait": "test_url",
   "otherAccount": "test_other",
   "userFrom": "test_0",
-  "groupCode": "集团code",
   "isAdmin": "0",
   "remark": "测试数据"
 }]
@@ -239,11 +241,11 @@
 [
   {
     "deptClassifyCode": "DEV_DATA",//非空
-    "code": "DEV_DMP",//建议非空
+    "code": "DEV_DMP",//非空
     "name": "数据中台",//非空
     "companyId": "1",//非空
     "parentId": "0",//“0”表示顶级部门,非空
-    "resourceFrom": "0",//非空
+    "resourceFrom": "0",
     "manager": "admin",
     "remark": "测试数据"
   }
@@ -253,12 +255,12 @@
 [
   {
     "id": "1",//非空
-    "deptClassifyCode": "DEV_DATA",//非空
-    "code": "DEV_DMP",//建议非空
-    "name": "数据中台",//非空
-    "companyId": "1",//非空
-    "parentId": "0",//非空
-    "resourceFrom": "0",//非空
+    "deptClassifyCode": "DEV_DATA",
+    "code": "DEV_DMP",
+    "name": "数据中台",
+    "companyId": "1",
+    "parentId": "0",
+    "resourceFrom": "0",
     "manager": "admin",
     "remark": "测试数据"
   }
@@ -273,6 +275,8 @@
 
 ### 部门分类
 
+<font color='red'>注:code、name不可重复</font>
+
 请求路径: /dept/classify/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
 请求参数:
@@ -304,8 +308,8 @@
 更新:[{},{}]
 [{
   "id": "1",//非空
-  "code": "DEV",//非空
-  "name": "开发",//非空
+  "code": "DEV",
+  "name": "开发",
   "parentId": "0",
   "orderNum": 1,
   "remark": "测试数据"
@@ -341,8 +345,8 @@
 }
 新增:[{},{}]
 [{
-  "code": "DEV_JAVA",//建议非空
-  "name": "Java开发",//建议非空
+  "code": "DEV_JAVA",//非空
+  "name": "Java开发",//非空
   "groupCode": "WD",//非空
   "userId": "1",//非空
   "deptId": "1",//非空
@@ -353,11 +357,11 @@
 更新:[{},{}]
 [{
   "id": "1",//非空
-  "code": "DEV_JAVA",//建议非空
-  "name": "Java开发",//建议非空
-  "userId": "1",//非空
-  "deptId": "1",//非空
-  "jobClassifyCode": "DEV_JAVA_CLASS",//非空
+  "code": "DEV_JAVA",
+  "name": "Java开发",
+  "userId": "1",
+  "deptId": "1",
+  "jobClassifyCode": "DEV_JAVA_CLASS",
   "resourceFrom": "0",
   "remark": "测试数据"
 }]
@@ -400,8 +404,8 @@
 [
   {
     "id": "1",//非空
-    "code": "DEV_JAVA_CLASS",//非空
-    "name": "开发",//非空
+    "code": "DEV_JAVA_CLASS",
+    "name": "开发",
     "orderNum": 1,
     "remark": "测试数据"
   }
@@ -414,7 +418,7 @@
 ]
 ```
 
-### 应用(只提供查询接口)
+### 应用(<font color='red'>只提供查询接口</font>
 
 请求路径:/application/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -440,7 +444,7 @@
   "remark": "测试数据"
 }
 ```
-### 功能
+### 功能(<font color='red'>只提供查询接口</font>)
 
 请求路径:/function/{condition}?userId=用户id&groupCode=集团编码&projectId=项目Id&appId=应用id
 
@@ -468,41 +472,6 @@
   "updateTime": 1602638923000,
   "remark": "测试数据"
 }
-新增:[{},{}]
-[{
-  "code": "DMP_FUNC",//非空
-  "name": "数据中台功能",//非空
-  "type": "test",
-  "parentId": "0",
-  "appId": "1",//非空
-  "functionUrl": "test_url",
-  "icon": "test_icon",
-  "description": "test_des",
-  "functionAlias": "test_alias",
-  "objType": "test_type",
-  "funcOrder": 1,
-  "remark": "测试数据"
-}]
-更新:[{},{}]
-[{
-  "id": "1",//非空
-  "code": "DMP_FUNC",//非空
-  "name": "数据中台功能",//非空
-  "type": "test",
-  "parentId": "0",
-  "appId": "1",//非空
-  "functionUrl": "test_url",
-  "icon": "test_icon",
-  "description": "test_des",
-  "functionAlias": "test_alias",
-  "objType": "test_type",
-  "funcOrder": 1,
-  "remark": "测试数据"
-}]
-删除:[{},{}]
-[{
-  "id": "1"
-}]
 ```
 ### 岗位分类与应用功能关系
 
@@ -528,7 +497,7 @@
 新增:[{},{}]
 [{
   "jobClassifyCode": "DEV_JAVA_CLASS",//非空
-  "appId": "1",
+  "appId": "1",//appId与functionId不能都为空
   "functionId": "1",
   "remark": "测试数据"
 }]
@@ -540,10 +509,12 @@
   "functionId": "1",
   "remark": "测试数据"
 }
-删除:
-{
-  "id": "1"
-}
+删除:[{},{}]
+[
+  {
+  	"id": "1"
+	}
+]
 ```
 
 ### 集团与应用的关系
@@ -568,18 +539,20 @@
 新增:[{},{}]
 [
   {
+    "appId": 1,//非空
     "groupCode": "XCJT",//非空
-    "appId": 1,
-    "authority_type": "0"
+    "authority_type": "0",
+    "remark": "测试数据"
 	}
 ]
 更新:[{},{}]
 [
   {
     "id": "1",//非空
-    "groupCode": "XCJT",//非空
     "appId": 1,
-    "authority_type": "0"
+    "groupCode": "XCJT",
+    "authority_type": "0",
+    "remark": "测试数据"
   }
 ]
 删除:[{},{}]
@@ -612,18 +585,20 @@
 新增:[{},{}]
 [
   {
+    "appId": 1,//非空
     "groupCode": "XCJT",//非空
-    "appId": 1,
-    "authority_type": "0"
+    "authority_type": "0",
+    "remark": "测试数据"
 	}
 ]
 更新:[{},{}]
 [
   {
     "id": "1",//非空
-    "groupCode": "XCJT",//非空
+    "groupCode": "XCJT",
     "functionId": 1,
-    "authority_type": "0"
+    "authority_type": "0",
+    "remark": "测试数据"
   }
 ]
 删除:[{},{}]