feat:增加金润对接钉钉审批接口

王富国
1 parent 4484c051
Showing 1 changed file with 31 additions and 22 deletions Show diff stats
jinrun/audit/审批接口.md
@@ -63,10 +63,9 @@ POST
  
 | 参数名                                 | 必传 | 类型     | 说明                                   |
 |-------------------------------------|----|--------|--------------------------------------|
-| code                                | 是  | string | 业务编号(确定数据唯一性,同一编号最多只能有1个审核通过或审核中的审批) |
+| id                                  | 是  | string | 业务主键(确定数据唯一性,同一编号最多只能有1个审核通过或审核中的审批) |
 | auditType                           | 是  | string | 审批类型(则一提供)                           |
 | username                            | 是  | string | 发起人工号(则一员工工号)                        |
-| orgCode                             | 否  | string | 业务所属组织(则一系统组织编号)                     |
 | auditFormList                       | 是  | list   | 审批表单字段列表                             |
 | &nbsp;&nbsp;&nbsp;&nbsp;type        | 是  | string | 字段类型(1.text 文本格式 2.file 文件格式)        |
 | &nbsp;&nbsp;&nbsp;&nbsp;name        | 是  | string | 字段名称                                 |
@@ -84,7 +83,10 @@ POST
     "businessException": false, //false表示无业务异常, true表示产生了业务异常,需要看messge异常原因
     "errorCode": null,
     "message": null,
-    "result": null
+    "result": {
+      "id": "2369f6c4c15440cdada803047d664546",   // 业务主键
+      "auditId": "2369f6c4c15440cdada803047d664546" //审批ID
+    }
 }
 ```
  
@@ -119,22 +121,27 @@ POST
  
 ### Body参数
  
-| 参数名                           | 必传 | 类型     | 说明             |
-|-------------------------------|----|--------|----------------|
-| code                          | 是  | string | 业务编号(确定数据唯一性)  |
-| type                          | 是  | string | 业务类型(则一提供) |
-| remark                        | 是  | string | 撤销原因           |
-| username                      | 是  | string | 撤销人员工号(则一员工工号) |
+| 参数名      | 必传 | 类型     | 说明             |
+|----------|----|--------|----------------|
+| id       | 是  | string | 业务主键(确定数据唯一性)  |
+| type     | 是  | string | 业务类型(则一提供)     |
+| remark   | 是  | string | 撤销原因           |
+| username | 是  | string | 撤销人员工号(则一员工工号) |
  
 #### 返回示例
  
 ```json
 {
-    "success": true, //true表示请求成功, false表示产生了异常,需要看messge异常原因
-    "businessException": false, //false表示无业务异常, true表示产生了业务异常,需要看messge异常原因
-    "errorCode": null,
-    "message": null,
-    "result": null
+  "success": true,
+  //true表示请求成功, false表示产生了异常,需要看messge异常原因
+  "businessException": false,
+  //false表示无业务异常, true表示产生了业务异常,需要看messge异常原因
+  "errorCode": null,
+  "message": null,
+  "result": {
+    "id": "2369f6c4c15440cdada803047d664546",
+    "auditId": "2369f6c4c15440cdada803047d664546"
+  }
 }
 ```
  
@@ -173,14 +180,16 @@ POST
  
 ### Body参数
  
-| 参数名                                    | 必传 | 类型   | 说明                                          |
-|----------------------------------------|----| ------ |---------------------------------------------|
-| code                                   | 是  | string | 业务编号                                        |
-| auditType                              | 是  | string | 审批类型                                        |
-| type                                   | 是  | string | 审批正常结束（同意或拒绝）的type为finish，审批终止的type为terminate |
-| result                                 | 否  | string | 正常结束时(agree:同意, refuse:拒绝)                  |
-| auditUser                              | 否  | string | 最终审核人                                       |
-| remark                                 | 否  | string | 审批意见                                        |
+| 参数名        | 必传 | 类型   | 说明                                            |
+|------------|----| ------ |-----------------------------------------------|
+| id         | 是  | string | 业务主键                                          |
+| auditId    | 是  | string | 审批ID                                          |
+| businessId | 是  | string | 审批编号                                          |
+| auditType  | 是  | string | 审批类型                                          |
+| type       | 是  | string | 审批正常结束（同意或拒绝）的type为finish，审批终止的type为terminate |
+| result     | 否  | string | 正常结束时(agree:同意, refuse:拒绝)                    |
+| auditUser  | 否  | string | 最终审核人                                         |
+| remark     | 否  | string | 审批意见                                          |
  
  
 ------------------------------------------------------------------------------------------
...	...	@@ -63,10 +63,9 @@ POST
63	63
64	64	\| 参数名 \| 必传 \| 类型 \| 说明 \|
65	65	\|-------------------------------------\|----\|--------\|--------------------------------------\|
66		-\| code \| 是 \| string \| 业务编号(确定数据唯一性,同一编号最多只能有1个审核通过或审核中的审批) \|
	66	+\| id \| 是 \| string \| 业务主键(确定数据唯一性,同一编号最多只能有1个审核通过或审核中的审批) \|
67	67	\| auditType \| 是 \| string \| 审批类型(则一提供) \|
68	68	\| username \| 是 \| string \| 发起人工号(则一员工工号) \|
69		-\| orgCode \| 否 \| string \| 业务所属组织(则一系统组织编号) \|
70	69	\| auditFormList \| 是 \| list \| 审批表单字段列表 \|
71	70	\|     type \| 是 \| string \| 字段类型(1.text 文本格式 2.file 文件格式) \|
72	71	\|     name \| 是 \| string \| 字段名称 \|
...	...	@@ -84,7 +83,10 @@ POST
84	83	"businessException": false, //false表示无业务异常, true表示产生了业务异常,需要看messge异常原因
85	84	"errorCode": null,
86	85	"message": null,
87		- "result": null
	86	+ "result": {
	87	+ "id": "2369f6c4c15440cdada803047d664546", // 业务主键
	88	+ "auditId": "2369f6c4c15440cdada803047d664546" //审批ID
	89	+ }
88	90	}
89	91	```
90	92
...	...	@@ -119,22 +121,27 @@ POST
119	121
120	122	### Body参数
121	123
122		-\| 参数名 \| 必传 \| 类型 \| 说明 \|
123		-\|-------------------------------\|----\|--------\|----------------\|
124		-\| code \| 是 \| string \| 业务编号(确定数据唯一性) \|
125		-\| type \| 是 \| string \| 业务类型(则一提供) \|
126		-\| remark \| 是 \| string \| 撤销原因 \|
127		-\| username \| 是 \| string \| 撤销人员工号(则一员工工号) \|
	124	+\| 参数名 \| 必传 \| 类型 \| 说明 \|
	125	+\|----------\|----\|--------\|----------------\|
	126	+\| id \| 是 \| string \| 业务主键(确定数据唯一性) \|
	127	+\| type \| 是 \| string \| 业务类型(则一提供) \|
	128	+\| remark \| 是 \| string \| 撤销原因 \|
	129	+\| username \| 是 \| string \| 撤销人员工号(则一员工工号) \|
128	130
129	131	#### 返回示例
130	132
131	133	```json
132	134	{
133		- "success": true, //true表示请求成功, false表示产生了异常,需要看messge异常原因
134		- "businessException": false, //false表示无业务异常, true表示产生了业务异常,需要看messge异常原因
135		- "errorCode": null,
136		- "message": null,
137		- "result": null
	135	+ "success": true,
	136	+ //true表示请求成功, false表示产生了异常,需要看messge异常原因
	137	+ "businessException": false,
	138	+ //false表示无业务异常, true表示产生了业务异常,需要看messge异常原因
	139	+ "errorCode": null,
	140	+ "message": null,
	141	+ "result": {
	142	+ "id": "2369f6c4c15440cdada803047d664546",
	143	+ "auditId": "2369f6c4c15440cdada803047d664546"
	144	+ }
138	145	}
139	146	```
140	147
...	...	@@ -173,14 +180,16 @@ POST
173	180
174	181	### Body参数
175	182
176		-\| 参数名 \| 必传 \| 类型 \| 说明 \|
177		-\|----------------------------------------\|----\| ------ \|---------------------------------------------\|
178		-\| code \| 是 \| string \| 业务编号 \|
179		-\| auditType \| 是 \| string \| 审批类型 \|
180		-\| type \| 是 \| string \| 审批正常结束（同意或拒绝）的type为finish，审批终止的type为terminate \|
181		-\| result \| 否 \| string \| 正常结束时(agree:同意, refuse:拒绝) \|
182		-\| auditUser \| 否 \| string \| 最终审核人 \|
183		-\| remark \| 否 \| string \| 审批意见 \|
	183	+\| 参数名 \| 必传 \| 类型 \| 说明 \|
	184	+\|------------\|----\| ------ \|-----------------------------------------------\|
	185	+\| id \| 是 \| string \| 业务主键 \|
	186	+\| auditId \| 是 \| string \| 审批ID \|
	187	+\| businessId \| 是 \| string \| 审批编号 \|
	188	+\| auditType \| 是 \| string \| 审批类型 \|
	189	+\| type \| 是 \| string \| 审批正常结束（同意或拒绝）的type为finish，审批终止的type为terminate \|
	190	+\| result \| 否 \| string \| 正常结束时(agree:同意, refuse:拒绝) \|
	191	+\| auditUser \| 否 \| string \| 最终审核人 \|
	192	+\| remark \| 否 \| string \| 审批意见 \|
184	193
185	194
186	195	------------------------------------------------------------------------------------------
...	...