|
|
|
**一、待办事项查询接口**
|
|
|
|
|
|
|
|
1. **简要描述:**
|
|
|
|
|
|
|
|
- 用户待办事项查询接口(由第三方供应商提供,我司调用,为了统一参数,方便配置)
|
|
|
|
|
|
|
|
2. **请求URL:**
|
|
|
|
- ` http://xx.com/api/todo `(可以自定义)
|
|
|
|
|
|
|
|
3. **请求方式:**
|
|
|
|
- GET
|
|
|
|
|
|
|
|
4. **请求参数:**
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|:---- |:---|:----- |----- |
|
|
|
|
|userId |是 |string |用户账号 |
|
|
|
|
|userCode |否 |string | 用户学工号 |
|
|
|
|
|occupy |否 |string | 用户的岗位信息,格式为院系:岗位:学工号,多个岗位信息之间逗号分隔 |
|
|
|
|
|locale |否 |string | 语言(zh,en等等) |
|
|
|
|
|
|
|
|
5. **返回参数**
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|:------ |:-----|----- |
|
|
|
|
|success |boolean |成功标识(true/false) |
|
|
|
|
|errno |int |错误代码,仅0表示成功 |
|
|
|
|
|error |string |错误信息 |
|
|
|
|
|total |int |当分页有效时,此字段给出所有数据的总数(可能比entities.length大);否则为0 |
|
|
|
|
|entities |列表 |待办信息 |
|
|
|
|
| id |string |唯一标识id |
|
|
|
|
| name |string |当前任务名称 |
|
|
|
|
| uri |string |待办uri |
|
|
|
|
| assignTime |Long |待办指派时间 |
|
|
|
|
| actionName |string |办理时选择的动作名称 |
|
|
|
|
| process |object |流程信息 |
|
|
|
|
|  entry |string |流水号 |
|
|
|
|
|  update |Long |流程实例最后操作时间(本⽤户) |
|
|
|
|
|  status |string |状态:todo |
|
|
|
|
|  id |string |唯⼀标识id |
|
|
|
|
|  name |string |事项名称【流程名称】 |
|
|
|
|
|  uri |string |待办uri |
|
|
|
|
|  tags |string |应⽤标签,可以有多个,以逗号分隔,第⼀个作为主分类 |
|
|
|
|
|  pendingTasks |string | 当前的所在步骤名称 |
|
|
|
|
|  app |object |应用信息 |
|
|
|
|
|   id |string |应用ID |
|
|
|
|
|   code |string |应用编码 |
|
|
|
|
|   name |string |应用名称 |
|
|
|
|
|   visible |string |是否可⻅ |
|
|
|
|
|
|
|
|
|
|
|
|
6. **返回示例**
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
"success": true,
|
|
|
|
"errno": 0,
|
|
|
|
"error": "success",
|
|
|
|
"total": 2,
|
|
|
|
"nextToken": null,
|
|
|
|
"entities": [{
|
|
|
|
"id": "2C094CBB-D0BA-41E3-B997-AD1B6ED63CCB",
|
|
|
|
"name": "当前任务名",
|
|
|
|
"uri ": "",
|
|
|
|
"process ": {
|
|
|
|
"entry ": "1",
|
|
|
|
"update": 1461747564,
|
|
|
|
"status": "todo",
|
|
|
|
"app": {
|
|
|
|
"id": "2C094CBB-D0BA-41E3-B997-AD1B6ED63CBB",
|
|
|
|
"code": "test",
|
|
|
|
"name": "app name",
|
|
|
|
"visible ": "1"
|
|
|
|
},
|
|
|
|
"id": "46BAB26E-38CB-45A5-B103-3DE189E06B94 ",
|
|
|
|
"name": "process name ",
|
|
|
|
"uri": "https: //www.baidu.com",
|
|
|
|
"tags": "test tag",
|
|
|
|
"pendingTasks": "test"
|
|
|
|
},
|
|
|
|
"assignTime": 1461747564,
|
|
|
|
"actionName": " "
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"id": "2C094CBB-D0BA-41E3-B997-AD1B6ED63CBB",
|
|
|
|
"name": "当前任务名,如:待审核、申请单填写",
|
|
|
|
"uri": "",
|
|
|
|
"process": {
|
|
|
|
"entry": "1",
|
|
|
|
"update": 1461747564,
|
|
|
|
"status": "todo",
|
|
|
|
"app":
|
|
|
|
{
|
|
|
|
"id": "2C094CBB-D0BA-41E3-B997-AD1B6ED63CBB",
|
|
|
|
"code": "test",
|
|
|
|
"name": "app name",
|
|
|
|
"visible": "1"
|
|
|
|
},
|
|
|
|
"id": "46BAB26E-38CB-45A5-B103-3DE189E06B94",
|
|
|
|
"name": "process name",
|
|
|
|
"uri": "https://www.baidu.com",
|
|
|
|
"tags": "test tag",
|
|
|
|
"pendingTasks": "test"
|
|
|
|
},
|
|
|
|
"assignTime": 1461747564,
|
|
|
|
"actionName": "123"
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
**二、办理中事宜查询接口**
|
|
|
|
|
|
|
|
|
|
|
|
1. **简要描述:**
|
|
|
|
|
|
|
|
- 用户待办事项查询接口(由第三方供应商提供,我司调用,为了统一参数,方便配置)
|
|
|
|
|
|
|
|
2. **请求URL:**
|
|
|
|
- ` http://xx.com/api/doing `(可以自定义)
|
|
|
|
|
|
|
|
3. **请求方式:**
|
|
|
|
- GET
|
|
|
|
|
|
|
|
4. **请求参数:**
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|:---- |:---|:----- |----- |
|
|
|
|
|userId |是 |string |用户账号 |
|
|
|
|
|userCode |否 |string | 用户学工号 |
|
|
|
|
|occupy |否 |string | 用户的岗位信息,格式为院系:岗位:学工号,多个岗位信息之间逗号分隔 |
|
|
|
|
|locale |否 |string | 语言(zh,en等等) |
|
|
|
|
|
|
|
|
|
|
|
|
5. **返回参数**
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|:------ |:-----|----- |
|
|
|
|
|success |boolean |成功标识(true/false) |
|
|
|
|
|errno |int |错误代码,仅0表示成功 |
|
|
|
|
|error |string |错误信息 |
|
|
|
|
|total |int |当分页有效时,此字段给出所有数据的总数(可能比entities.length大);否则为0 |
|
|
|
|
|entities |列表 |办理中流程信息 |
|
|
|
|
| entry |string |/流程实例流⽔号 |
|
|
|
|
| update |string |更新时间 |
|
|
|
|
| status |string |流程状态,doing |
|
|
|
|
| id |string |流程实例ID |
|
|
|
|
| name |string |流程实例名称 |
|
|
|
|
| uri |string |统⼀认证的应⽤链接 |
|
|
|
|
| tags |string |应⽤标签,可以有多个,以逗号分隔,第⼀个作为主分类 |
|
|
|
|
| pendingTasks |string |当前的所在步骤名称 |
|
|
|
|
| app|object |应用信息 |
|
|
|
|
|   id |string |应用ID |
|
|
|
|
|   code |string |应用编码 |
|
|
|
|
|   name |string |应用名称 |
|
|
|
|
|   visible |string |是否可⻅ |
|
|
|
|
|
|
|
|
6. **返回示例**
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
"success": true,
|
|
|
|
"errno": 0,
|
|
|
|
"error": "success",
|
|
|
|
"total": 2,
|
|
|
|
"entities": [{
|
|
|
|
"entry": "1",
|
|
|
|
"update": 1461744669,
|
|
|
|
"status": "doing",
|
|
|
|
"id": "2CD884BB-3B62-48B1-AB8C-9D39E7BF9A89",
|
|
|
|
"name": "taskapi测试",
|
|
|
|
"app": {
|
|
|
|
"id": "416B4F08-FC29-44F1-B14A-3201E1EBEC07",
|
|
|
|
"code": "test",
|
|
|
|
"name": "test",
|
|
|
|
"visible": "1"
|
|
|
|
},
|
|
|
|
"uri": "https://www.baidu.com",
|
|
|
|
"tags": "test tag",
|
|
|
|
"pendingTasks": "test"
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"entry": "2",
|
|
|
|
"update": 1461744669,
|
|
|
|
"status": "doing",
|
|
|
|
"id": "FEAE7025-12D7-4757-BC43-44CE95D41CDD",
|
|
|
|
"name": "taskapi测试",
|
|
|
|
"app":
|
|
|
|
{
|
|
|
|
"id": "416B4F08-FC29-44F1-B14A-3201E1EBEC07",
|
|
|
|
"code": "test",
|
|
|
|
"name": "test",
|
|
|
|
"visible": "1"
|
|
|
|
},
|
|
|
|
"uri": "https://www.baidu.com",
|
|
|
|
"tags": "test tag",
|
|
|
|
"pendingTasks": "test"
|
|
|
|
}]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
**三、已完成事宜查询接口**
|
|
|
|
|
|
|
|
|
|
|
|
1. **简要描述:**
|
|
|
|
|
|
|
|
- 已完成事宜查询接口(由第三方供应商提供,我司调用,为了统一参数,方便配置)
|
|
|
|
|
|
|
|
2. **请求URL:**
|
|
|
|
- ` http://xx.com/api/done `(可以自定义)
|
|
|
|
|
|
|
|
3. **请求方式:**
|
|
|
|
- GET
|
|
|
|
|
|
|
|
4. **请求参数:**
|
|
|
|
|
|
|
|
|参数名|必选|类型|说明|
|
|
|
|
|:---- |:---|:----- |----- |
|
|
|
|
|userId |是 |string |用户账号 |
|
|
|
|
|userCode |否 |string | 用户学工号 |
|
|
|
|
|occupy |否 |string | 用户的岗位信息,格式为院系:岗位:学工号,多个岗位信息之间逗号分隔 |
|
|
|
|
|locale |否 |string | 语言(zh,en等等) |
|
|
|
|
|
|
|
|
|
|
|
|
5. **返回参数**
|
|
|
|
|
|
|
|
|参数名|类型|说明|
|
|
|
|
|:------ |:-----|----- |
|
|
|
|
|success |boolean |成功标识(true/false) |
|
|
|
|
|errno |int |错误代码,仅0表示成功 |
|
|
|
|
|error |string |错误信息 |
|
|
|
|
|total |int |当分页有效时,此字段给出所有数据的总数(可能比entities.length大);否则为0 |
|
|
|
|
|entities |列表 |已完成流程信息 |
|
|
|
|
| entry |string |流程实例流⽔号 |
|
|
|
|
| update |string |更新时间 |
|
|
|
|
| status |string |流程状态,done |
|
|
|
|
| id |string |流程实例ID |
|
|
|
|
| name |string |流程实例名称 |
|
|
|
|
| uri |string |统⼀认证的应⽤链接 |
|
|
|
|
| tags |string |应⽤标签,可以有多个,以逗号分隔,第⼀个作为主分类 |
|
|
|
|
| pendingTasks |string |当前的所在步骤名称 |
|
|
|
|
| app|object |应用信息 |
|
|
|
|
|   id |string |应用ID |
|
|
|
|
|   code |string |应用编码 |
|
|
|
|
|   name |string |应用名称 |
|
|
|
|
|   visible |string |是否可⻅ |
|
|
|
|
|
|
|
|
|
|
|
|
6. **返回示例**
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
"success": true,
|
|
|
|
"errno": 0,
|
|
|
|
"error": "success",
|
|
|
|
"total": 2,
|
|
|
|
"entities": [{
|
|
|
|
"entry": "1",
|
|
|
|
"update": 1461744669,
|
|
|
|
"status": "done",
|
|
|
|
"id": "2CD884BB-3B62-48B1-AB8C-9D39E7BF9A89",
|
|
|
|
"name": "taskapi测试",
|
|
|
|
"create": 1461745588,
|
|
|
|
"app": {
|
|
|
|
"id": "416B4F08-FC29-44F1-B14A-3201E1EBEC07",
|
|
|
|
"code": "test",
|
|
|
|
"name": "test",
|
|
|
|
"visible": "1"
|
|
|
|
},
|
|
|
|
"uri": "https://www.baidu.com",
|
|
|
|
"tags": "test tag",
|
|
|
|
"pendingTasks": "test"
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"entry": "1",
|
|
|
|
"update": 1461744669,
|
|
|
|
"status": "done",
|
|
|
|
"id": "FEAE7025-12D7-4757-BC43-44CE95D41CDD",
|
|
|
|
"name": "taskapi测试1",
|
|
|
|
"create": 1461745599,
|
|
|
|
"app": {
|
|
|
|
"id": "416B4F08-FC29-44F1-B14A-3201E1EBEC07",
|
|
|
|
"code": "test",
|
|
|
|
"name": "test",
|
|
|
|
"visible": "1"
|
|
|
|
},
|
|
|
|
"uri": "https://www.baidu.com",
|
|
|
|
"tags": "test tag",
|
|
|
|
"pendingTasks": "test"
|
|
|
|
}]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|