瀏覽代碼

人员组织权限接口文档

wudla 4 年之前
父節點
當前提交
7dd9e288db
共有 1 個文件被更改,包括 193 次插入0 次删除
  1. 193 0
      api document/orgnization_Api.md

+ 193 - 0
api document/orgnization_Api.md

@@ -0,0 +1,193 @@
+# 人员组织权限接口文档
+
+
+
+以下查询为模板案例:参考实体类 Example
+
+| 字段 | 类型   |
+| ---- | ------ |
+| id   | int    |
+| name | string |
+| age  | int    |
+
+### 查询
+
+​	[通用查询](http://git.sagacloud.cn/sagacloud/paas-doc/src/e172ee3ddd372d8f3b0f205cf337f85d3f6dadd4/通用查询.md)
+
+### 新增
+
+请求地址
+
+```json
+POST: /example/create
+```
+
+请求参数
+
+```json
+{
+    "id": "1",
+    "name": "test",
+    "age": "23"
+}
+```
+
+##### 返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "1"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "success",
+    "message": "错误信息,如果接口发生错误会返回该字段"
+}
+```
+
+
+
+### 更新
+
+请求地址
+
+```json
+POST: /example/update
+```
+
+请求参数
+
+```json
+{
+    "id": "1",
+    "name": "test",
+    "age": "23"
+}
+```
+
+##### 返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "123456"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "success",
+    "message": "错误信息,如果接口发生错误会返回该字段"
+}
+```
+
+
+
+### 删除
+
+请求地址
+
+```json
+POST: /example/delete
+```
+
+请求参数
+
+```json
+{
+    "id": "1",
+    "name": "test",
+    "age": "23"
+}
+```
+
+##### 返回结果:
+
+正确JSON示例
+
+```json
+{
+    "result": "success",
+    "message": null,
+    "data": {
+        "id": "1"
+    }
+}
+```
+
+错误JSON示例
+
+```json
+{
+    "result": "success",
+    "message": "错误信息,如果接口发生错误会返回该字段"
+}
+```
+
+### 
+
+### 系统接口路径
+
+### (注:condition 为 query,create,update,delete)
+
+### (注:为了读写分离,serviceid还会变动,请不要写死)
+
+### (注:传入参数请参考[SQL文档](http://git.sagacloud.cn/persagy/persagy-dmp-doc/src/master/SQL/org.ddl.sql),字段有下划线改为驼峰)
+
+####请求方法:POST
+
+#### 请求路径:
+
+```json
+集团
+  /group/{condition}
+  
+公司
+  /company/{condition}
+  
+项目
+	/project/{condition}
+
+部门
+  /dept/{condition}
+
+人员账号
+  /user/{condition}
+
+部门分类
+  /dept/classify/{condition}
+
+岗位分类
+  /job/classify/{condition}
+
+岗位
+  /job/{condition}
+
+应用
+  /application/{condition}
+
+功能
+  /function/{condition}
+
+岗位分类与应用功能关系
+  /job/classify/rel/{condition}
+
+```
+