Version | Update Time | Status | Author | Description |
---|---|---|---|---|
v2021-12-01 16:18:34 | 2021-12-01 16:18:34 | auto | @finegirl | Created by smart-doc |
1. 流程定义部署接口类
1.1. 流程部署列表查询
Type: POST
Content-Type: application/json; charset=utf-8
Description: 流程部署列表查询
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
page | object | 分页对象 | false | - |
└─per | int32 | No comments found. | false | - |
└─size | int32 | No comments found. | false | - |
└─total | int32 | No comments found. | false | - |
query | object | 列表查询对象 | false | - |
└─platformSn | string | 业务平台标识(唯一) | false | - |
└─userCode | string | 业务平台用户id | false | - |
└─deployId | string | 流程部署ID | false | - |
└─processInstanceId | string | 流程实例ID | false | - |
└─candidateUsers | array | 候选人 | false | - |
└─candidateGroups | array | 审批组 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/definition/deploy/list --data '{
"page": {
"per": 699,
"size": 10,
"total": 193
},
"query": {
"platformSn": "xjdqz6",
"userCode": "8174",
"deployId": "76",
"processInstanceId": "76",
"candidateUsers": [
"is3l96"
],
"candidateGroups": [
"0ykqqo"
]
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
└─page | object | No comments found. | - |
└─per | int32 | No comments found. | - |
└─size | int32 | No comments found. | - |
└─total | int32 | No comments found. | - |
└─list | array | No comments found. | - |
└─id | string | 流程定义id | - |
└─name | string | 流程名称 | - |
└─key | string | 流程key | - |
└─category | string | 流程分类 | - |
└─version | int32 | 版本 | - |
└─deploymentId | string | 流程部署id | - |
└─suspensionState | int32 | 流程定义状态: 1:激活 , 2:中止 | - |
└─deploymentTime | string | 部署时间 | - |
Response-example:
{
"code": 905,
"msg": "3qkr5t",
"data": {
"page": {
"per": 873,
"size": 10,
"total": 490
},
"list": [
{
"id": "76",
"name": "嘉熙.万",
"key": "lwrw3y",
"category": "0ujjrg",
"version": 191,
"deploymentId": "76",
"suspensionState": 2,
"deploymentTime": "2021-12-01 16:18:39"
}
]
}
}
1.2. 激活或挂起流程定义(已经部署)
Type: POST
Content-Type: application/json; charset=utf-8
Description: 激活或挂起流程定义(已经部署)
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
platformSn | string | 业务系统标识 | false | - |
deployId | string | 流程部署ID | false | - |
state | int32 | 流程部署状态(1:激活,2:挂起) | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/definition/deploy/updateState --data '{
"platformSn": "89hvcn",
"deployId": "76",
"state": 2
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 157,
"msg": "utq4sk",
"data": {
"waring": "You may have used non-display generics."
}
}
1.3. 根据流程定义 ID 获取流程图 返回BASE64图片
Type: POST
Content-Type: application/json; charset=utf-8
Description: 根据流程定义 ID 获取流程图 返回BASE64图片
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
platformSn | string | 业务系统标识 | false | - |
deployId | string | 流程部署ID | false | - |
state | int32 | 流程部署状态(1:激活,2:挂起) | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/definition/deploy/readImage --data '{
"platformSn": "fqaeed",
"deployId": "76",
"state": 2
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 85,
"msg": "7w9v2x",
"data": "csi26h"
}
1.4. 根据流程定义 ID 获取xml
Type: POST
Content-Type: application/json; charset=utf-8
Description: 根据流程定义 ID 获取xml
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
platformSn | string | 业务系统标识 | false | - |
deployId | string | 流程部署ID | false | - |
state | int32 | 流程部署状态(1:激活,2:挂起) | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/definition/deploy/readXml --data '{
"platformSn": "g2p05n",
"deployId": "76",
"state": 2
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 966,
"msg": "ucmi23",
"data": "m9bj5z"
}
2. 工作流流程对外服务接口
2.1. 启动流程
Type: POST
Content-Type: application/json; charset=utf-8
Description: 启动流程
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
processDefinitionKey | string | No comments found. | false | - |
businessKey | string | No comments found. | false | - |
formName | string | No comments found. | false | - |
variables | map | No comments found. | false | - |
└─any object | object | any object. | false | - |
userCode | string | No comments found. | false | - |
platformSn | string | No comments found. | false | - |
creator | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/process/start --data '{
"processDefinitionKey": "26npyd",
"businessKey": "qckf7a",
"formName": "嘉熙.万",
"variables": {
"mapKey": {}
},
"userCode": "8174",
"platformSn": "a3dz82",
"creator": "xhr9fw"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 770,
"msg": "dk08by",
"data": "dabwq6"
}
2.2. 获取el表达式
Type: POST
Content-Type: application/json; charset=utf-8
Description: 获取el表达式
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
processDefinitionKey | string | No comments found. | false | - |
businessKey | string | No comments found. | false | - |
formName | string | No comments found. | false | - |
variables | map | No comments found. | false | - |
└─any object | object | any object. | false | - |
userCode | string | No comments found. | false | - |
platformSn | string | No comments found. | false | - |
creator | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/process/getAllProcessInstanceEl --data '{
"processDefinitionKey": "2bjuoe",
"businessKey": "i664he",
"formName": "嘉熙.万",
"variables": {
"mapKey": {}
},
"userCode": "8174",
"platformSn": "4xrgln",
"creator": "ldmwv3"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | array | 响应数据 | - |
└─taskId | string | No comments found. | - |
└─userId | string | No comments found. | - |
└─comment | string | No comments found. | - |
└─instanceId | string | No comments found. | - |
└─targetKey | string | No comments found. | - |
└─name | string | No comments found. | - |
└─values | map | No comments found. | - |
└─any object | object | any object. | - |
└─assignee | string | No comments found. | - |
└─candidateUsers | array | No comments found. | - |
└─candidateGroups | array | No comments found. | - |
└─tenantId | string | No comments found. | - |
└─el | string | No comments found. | - |
└─multiple | int32 | No comments found. | - |
Response-example:
{
"code": 312,
"msg": "14wunf",
"data": [
{
"taskId": "76",
"userId": "76",
"comment": "iuvtm9",
"instanceId": "76",
"targetKey": "6krxwj",
"name": "嘉熙.万",
"values": {
"mapKey": {}
},
"assignee": "wvv7b2",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"tenantId": "76",
"el": "c3dih3",
"multiple": 853
}
]
}
2.3. 激活或挂起流程实例
Type: POST
Content-Type: application/json; charset=utf-8
Description: 激活或挂起流程实例
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userCode | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
suspensionState | int32 | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/process/updateState --data '{
"userCode": "8174",
"processInstanceId": "76",
"suspensionState": 2
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 372,
"msg": "9ymjbz",
"data": {
"waring": "You may have used non-display generics."
}
}
2.4. 终止流程
Type: POST
Content-Type: application/json; charset=utf-8
Description: 终止流程
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userCode | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/process/stop --data '{
"userCode": "8174",
"processInstanceId": "76"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 56,
"msg": "hkrlkq",
"data": "ye9950"
}
2.5. 删除流程
Type: POST
Content-Type: application/json; charset=utf-8
Description: 删除流程
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userCode | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
deleteReason | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/process/delete --data '{
"userCode": "8174",
"processInstanceId": "76",
"deleteReason": "o580dx"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 725,
"msg": "5ddpyy",
"data": {
"waring": "You may have used non-display generics."
}
}
2.6. 获取流程执行过程
Type: POST
Content-Type: application/json; charset=utf-8
Description: 获取流程执行过程
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userCode | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/process/getFlowViewer --data '{
"userCode": "8174",
"processInstanceId": "76"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | array | 响应数据 | - |
└─key | string | No comments found. | - |
└─completed | boolean | No comments found. | - |
Response-example:
{
"code": 316,
"msg": "7id1j4",
"data": [
{
"key": "jcncsq",
"completed": true
}
]
}
2.7. 根据流程实例ID 获取当前流程运行情况 返回BASE64图片
Type: POST
Content-Type: application/json; charset=utf-8
Description: 根据流程实例ID 获取当前流程运行情况 返回BASE64图片
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
userCode | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/process/getImage --data '{
"userCode": "8174",
"processInstanceId": "76"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 924,
"msg": "5f4qwu",
"data": "4oyq7n"
}
3. 工作流任务对外服务接口
3.1. 我发起的流程
Type: POST
Content-Type: application/json; charset=utf-8
Description: 我发起的流程
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
page | object | 分页对象 | false | - |
└─per | int32 | No comments found. | false | - |
└─size | int32 | No comments found. | false | - |
└─total | int32 | No comments found. | false | - |
query | object | 列表查询对象 | false | - |
└─platformSn | string | 业务平台标识(唯一) | false | - |
└─userCode | string | 业务平台用户id | false | - |
└─deployId | string | 流程部署ID | false | - |
└─processInstanceId | string | 流程实例ID | false | - |
└─candidateUsers | array | 候选人 | false | - |
└─candidateGroups | array | 审批组 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/myProcess --data '{
"page": {
"per": 976,
"size": 10,
"total": 956
},
"query": {
"platformSn": "4vvj4q",
"userCode": "8174",
"deployId": "76",
"processInstanceId": "76",
"candidateUsers": [
"k99wg2"
],
"candidateGroups": [
"ghrljy"
]
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
└─page | object | No comments found. | - |
└─per | int32 | No comments found. | - |
└─size | int32 | No comments found. | - |
└─total | int32 | No comments found. | - |
└─list | array | No comments found. | - |
└─taskId | string | No comments found. | - |
└─taskName | string | No comments found. | - |
└─subTask | int32 | No comments found. | - |
└─parentTaskId | string | No comments found. | - |
└─businessKey | string | No comments found. | - |
└─formName | string | No comments found. | - |
└─targetKey | string | No comments found. | - |
└─taskDefKey | string | No comments found. | - |
└─assigneeId | string | No comments found. | - |
└─assigneeName | string | No comments found. | - |
└─startUserId | string | No comments found. | - |
└─startUserName | string | No comments found. | - |
└─category | string | No comments found. | - |
└─procVars | object | No comments found. | - |
└─taskLocalVars | object | No comments found. | - |
└─deployId | string | No comments found. | - |
└─procDefId | string | No comments found. | - |
└─procDefKey | string | No comments found. | - |
└─procDefName | string | No comments found. | - |
└─procDefVersion | int32 | No comments found. | - |
└─procInsId | string | No comments found. | - |
└─hisProcInsId | string | No comments found. | - |
└─duration | string | No comments found. | - |
└─comment | object | No comments found. | - |
└─type | string | No comments found. | - |
└─comment | string | No comments found. | - |
└─candidate | string | No comments found. | - |
└─createTime | string | No comments found. | - |
└─finishTime | string | No comments found. | - |
└─values | map | No comments found. | - |
└─any object | object | any object. | - |
└─attachmentList | array | No comments found. | - |
└─userCode | string | No comments found. | - |
└─assignee | string | No comments found. | - |
└─candidateUsers | array | No comments found. | - |
└─candidateGroups | array | No comments found. | - |
└─platformSn | string | No comments found. | - |
└─el | string | No comments found. | - |
Response-example:
{
"code": 550,
"msg": "5122n0",
"data": {
"page": {
"per": 732,
"size": 10,
"total": 447
},
"list": [
{
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 734,
"parentTaskId": "76",
"businessKey": "ozsm04",
"formName": "嘉熙.万",
"targetKey": "h4z3kz",
"taskDefKey": "22osp6",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "6cj23v",
"procVars": {
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 824,
"parentTaskId": "76",
"businessKey": "y6wc89",
"formName": "嘉熙.万",
"targetKey": "nd4age",
"taskDefKey": "guo43x",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "fuwbxb",
"procVars": {
"waring": "You may have used non-display generics."
},
"taskLocalVars": {
"waring": "You may have used non-display generics."
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "g370v3",
"procDefName": "嘉熙.万",
"procDefVersion": 743,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "ukt99j",
"comment": {
"type": "9y2gk8",
"comment": "fkheg7"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:40",
"finishTime": "2021-12-01 16:18:40",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"object": "any object"
}
],
"userCode": "8174",
"assignee": "uudhyt",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "j2altm",
"el": "jz5vne"
},
"taskLocalVars": {
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 405,
"parentTaskId": "76",
"businessKey": "kj0y2p",
"formName": "嘉熙.万",
"targetKey": "axeeqe",
"taskDefKey": "2tnnzw",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "g1pz7a",
"procVars": {
"waring": "You may have used non-display generics."
},
"taskLocalVars": {
"waring": "You may have used non-display generics."
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "tvqejv",
"procDefName": "嘉熙.万",
"procDefVersion": 775,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "f7fa2n",
"comment": {
"type": "jdus6k",
"comment": "ohl8sl"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:40",
"finishTime": "2021-12-01 16:18:40",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"object": "any object"
}
],
"userCode": "8174",
"assignee": "2n40it",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "nyjx2t",
"el": "j0jhji"
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "2io6tk",
"procDefName": "嘉熙.万",
"procDefVersion": 102,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "dno9rp",
"comment": {
"type": "vf0h4f",
"comment": "6lbwcx"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:40",
"finishTime": "2021-12-01 16:18:40",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"$ref": ".."
}
],
"userCode": "8174",
"assignee": "x94l0e",
"candidateUsers": [
{
"$ref": ".."
}
],
"candidateGroups": [
{
"$ref": ".."
}
],
"platformSn": "39n996",
"el": "wlgmq7"
}
]
}
}
3.2. 获取待办列表获取的列表需要和业务系统数据合并
Type: POST
Content-Type: application/json; charset=utf-8
Description: 获取待办列表 获取的列表需要和业务系统数据合并
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
page | object | 分页对象 | false | - |
└─per | int32 | No comments found. | false | - |
└─size | int32 | No comments found. | false | - |
└─total | int32 | No comments found. | false | - |
query | object | 列表查询对象 | false | - |
└─platformSn | string | 业务平台标识(唯一) | false | - |
└─userCode | string | 业务平台用户id | false | - |
└─deployId | string | 流程部署ID | false | - |
└─processInstanceId | string | 流程实例ID | false | - |
└─candidateUsers | array | 候选人 | false | - |
└─candidateGroups | array | 审批组 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/todoList --data '{
"page": {
"per": 840,
"size": 10,
"total": 1
},
"query": {
"platformSn": "k9z29s",
"userCode": "8174",
"deployId": "76",
"processInstanceId": "76",
"candidateUsers": [
"b32f3c"
],
"candidateGroups": [
"wqedhd"
]
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
└─page | object | No comments found. | - |
└─per | int32 | No comments found. | - |
└─size | int32 | No comments found. | - |
└─total | int32 | No comments found. | - |
└─list | array | No comments found. | - |
└─taskId | string | No comments found. | - |
└─taskName | string | No comments found. | - |
└─subTask | int32 | No comments found. | - |
└─parentTaskId | string | No comments found. | - |
└─businessKey | string | No comments found. | - |
└─formName | string | No comments found. | - |
└─targetKey | string | No comments found. | - |
└─taskDefKey | string | No comments found. | - |
└─assigneeId | string | No comments found. | - |
└─assigneeName | string | No comments found. | - |
└─startUserId | string | No comments found. | - |
└─startUserName | string | No comments found. | - |
└─category | string | No comments found. | - |
└─procVars | object | No comments found. | - |
└─taskLocalVars | object | No comments found. | - |
└─deployId | string | No comments found. | - |
└─procDefId | string | No comments found. | - |
└─procDefKey | string | No comments found. | - |
└─procDefName | string | No comments found. | - |
└─procDefVersion | int32 | No comments found. | - |
└─procInsId | string | No comments found. | - |
└─hisProcInsId | string | No comments found. | - |
└─duration | string | No comments found. | - |
└─comment | object | No comments found. | - |
└─type | string | No comments found. | - |
└─comment | string | No comments found. | - |
└─candidate | string | No comments found. | - |
└─createTime | string | No comments found. | - |
└─finishTime | string | No comments found. | - |
└─values | map | No comments found. | - |
└─any object | object | any object. | - |
└─attachmentList | array | No comments found. | - |
└─userCode | string | No comments found. | - |
└─assignee | string | No comments found. | - |
└─candidateUsers | array | No comments found. | - |
└─candidateGroups | array | No comments found. | - |
└─platformSn | string | No comments found. | - |
└─el | string | No comments found. | - |
Response-example:
{
"code": 693,
"msg": "1rfoj4",
"data": {
"page": {
"per": 713,
"size": 10,
"total": 288
},
"list": [
{
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 136,
"parentTaskId": "76",
"businessKey": "n5iyx1",
"formName": "嘉熙.万",
"targetKey": "iva31m",
"taskDefKey": "jmbax5",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "98v523",
"procVars": {
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 474,
"parentTaskId": "76",
"businessKey": "8ji8vp",
"formName": "嘉熙.万",
"targetKey": "uj2cf5",
"taskDefKey": "emn042",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "ark1g4",
"procVars": {
"waring": "You may have used non-display generics."
},
"taskLocalVars": {
"waring": "You may have used non-display generics."
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "xdbavt",
"procDefName": "嘉熙.万",
"procDefVersion": 375,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "9p3mar",
"comment": {
"type": "vqnb5l",
"comment": "cr8h1u"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"object": "any object"
}
],
"userCode": "8174",
"assignee": "nmgftd",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "tspeuh",
"el": "bj1t6m"
},
"taskLocalVars": {
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 936,
"parentTaskId": "76",
"businessKey": "zusz1p",
"formName": "嘉熙.万",
"targetKey": "5qhn02",
"taskDefKey": "pw0w5k",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "pl2x8u",
"procVars": {
"waring": "You may have used non-display generics."
},
"taskLocalVars": {
"waring": "You may have used non-display generics."
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "9splly",
"procDefName": "嘉熙.万",
"procDefVersion": 721,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "se5bff",
"comment": {
"type": "cvqxn6",
"comment": "15k4hg"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"object": "any object"
}
],
"userCode": "8174",
"assignee": "gbwhvu",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "s8kv8n",
"el": "z4sacf"
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "4d5y2l",
"procDefName": "嘉熙.万",
"procDefVersion": 654,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "utv035",
"comment": {
"type": "cf5cfh",
"comment": "byanxz"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"$ref": ".."
}
],
"userCode": "8174",
"assignee": "5eeylz",
"candidateUsers": [
{
"$ref": ".."
}
],
"candidateGroups": [
{
"$ref": ".."
}
],
"platformSn": "s6bh6c",
"el": "52nf68"
}
]
}
}
3.3. 获取已办任务获取的列表需要和业务系统数据合并
Type: POST
Content-Type: application/json; charset=utf-8
Description: 获取已办任务 获取的列表需要和业务系统数据合并
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
page | object | 分页对象 | false | - |
└─per | int32 | No comments found. | false | - |
└─size | int32 | No comments found. | false | - |
└─total | int32 | No comments found. | false | - |
query | object | 列表查询对象 | false | - |
└─platformSn | string | 业务平台标识(唯一) | false | - |
└─userCode | string | 业务平台用户id | false | - |
└─deployId | string | 流程部署ID | false | - |
└─processInstanceId | string | 流程实例ID | false | - |
└─candidateUsers | array | 候选人 | false | - |
└─candidateGroups | array | 审批组 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/finishedList --data '{
"page": {
"per": 253,
"size": 10,
"total": 912
},
"query": {
"platformSn": "s20b1l",
"userCode": "8174",
"deployId": "76",
"processInstanceId": "76",
"candidateUsers": [
"w0nzr4"
],
"candidateGroups": [
"7a40jc"
]
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
└─page | object | No comments found. | - |
└─per | int32 | No comments found. | - |
└─size | int32 | No comments found. | - |
└─total | int32 | No comments found. | - |
└─list | array | No comments found. | - |
└─taskId | string | No comments found. | - |
└─taskName | string | No comments found. | - |
└─subTask | int32 | No comments found. | - |
└─parentTaskId | string | No comments found. | - |
└─businessKey | string | No comments found. | - |
└─formName | string | No comments found. | - |
└─targetKey | string | No comments found. | - |
└─taskDefKey | string | No comments found. | - |
└─assigneeId | string | No comments found. | - |
└─assigneeName | string | No comments found. | - |
└─startUserId | string | No comments found. | - |
└─startUserName | string | No comments found. | - |
└─category | string | No comments found. | - |
└─procVars | object | No comments found. | - |
└─taskLocalVars | object | No comments found. | - |
└─deployId | string | No comments found. | - |
└─procDefId | string | No comments found. | - |
└─procDefKey | string | No comments found. | - |
└─procDefName | string | No comments found. | - |
└─procDefVersion | int32 | No comments found. | - |
└─procInsId | string | No comments found. | - |
└─hisProcInsId | string | No comments found. | - |
└─duration | string | No comments found. | - |
└─comment | object | No comments found. | - |
└─type | string | No comments found. | - |
└─comment | string | No comments found. | - |
└─candidate | string | No comments found. | - |
└─createTime | string | No comments found. | - |
└─finishTime | string | No comments found. | - |
└─values | map | No comments found. | - |
└─any object | object | any object. | - |
└─attachmentList | array | No comments found. | - |
└─userCode | string | No comments found. | - |
└─assignee | string | No comments found. | - |
└─candidateUsers | array | No comments found. | - |
└─candidateGroups | array | No comments found. | - |
└─platformSn | string | No comments found. | - |
└─el | string | No comments found. | - |
Response-example:
{
"code": 76,
"msg": "z0skep",
"data": {
"page": {
"per": 116,
"size": 10,
"total": 170
},
"list": [
{
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 955,
"parentTaskId": "76",
"businessKey": "ql2goe",
"formName": "嘉熙.万",
"targetKey": "05tn37",
"taskDefKey": "8o8xva",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "sdpi1a",
"procVars": {
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 645,
"parentTaskId": "76",
"businessKey": "83liko",
"formName": "嘉熙.万",
"targetKey": "vh79yx",
"taskDefKey": "zp7pqr",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "cztwqh",
"procVars": {
"waring": "You may have used non-display generics."
},
"taskLocalVars": {
"waring": "You may have used non-display generics."
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "gek6nt",
"procDefName": "嘉熙.万",
"procDefVersion": 862,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "xf5nhu",
"comment": {
"type": "l5uq7b",
"comment": "c5w9hq"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"object": "any object"
}
],
"userCode": "8174",
"assignee": "rw686o",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "joeo02",
"el": "1jt9lb"
},
"taskLocalVars": {
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 430,
"parentTaskId": "76",
"businessKey": "wnhmc5",
"formName": "嘉熙.万",
"targetKey": "bcn1q6",
"taskDefKey": "r0trds",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "vf63xl",
"procVars": {
"waring": "You may have used non-display generics."
},
"taskLocalVars": {
"waring": "You may have used non-display generics."
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "c8n3ab",
"procDefName": "嘉熙.万",
"procDefVersion": 247,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "wdpw6z",
"comment": {
"type": "q7vp4r",
"comment": "6d1l7j"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"object": "any object"
}
],
"userCode": "8174",
"assignee": "ljrqho",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "tcsaf6",
"el": "02t1h1"
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "1lbpaw",
"procDefName": "嘉熙.万",
"procDefVersion": 975,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "gr4zzd",
"comment": {
"type": "3w3dg9",
"comment": "ghjbuh"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"$ref": ".."
}
],
"userCode": "8174",
"assignee": "pvxqhp",
"candidateUsers": [
{
"$ref": ".."
}
],
"candidateGroups": [
{
"$ref": ".."
}
],
"platformSn": "q38rjs",
"el": "oolglx"
}
]
}
}
3.4. 流程历史流转记录
Type: POST
Content-Type: application/json; charset=utf-8
Description: 流程历史流转记录
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
page | object | 分页对象 | false | - |
└─per | int32 | No comments found. | false | - |
└─size | int32 | No comments found. | false | - |
└─total | int32 | No comments found. | false | - |
query | object | 列表查询对象 | false | - |
└─platformSn | string | 业务平台标识(唯一) | false | - |
└─userCode | string | 业务平台用户id | false | - |
└─deployId | string | 流程部署ID | false | - |
└─processInstanceId | string | 流程实例ID | false | - |
└─candidateUsers | array | 候选人 | false | - |
└─candidateGroups | array | 审批组 | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/flowRecord --data '{
"page": {
"per": 354,
"size": 10,
"total": 538
},
"query": {
"platformSn": "kb15o3",
"userCode": "8174",
"deployId": "76",
"processInstanceId": "76",
"candidateUsers": [
"uuwkf7"
],
"candidateGroups": [
"6mdggp"
]
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
└─page | object | No comments found. | - |
└─per | int32 | No comments found. | - |
└─size | int32 | No comments found. | - |
└─total | int32 | No comments found. | - |
└─list | array | No comments found. | - |
└─taskId | string | No comments found. | - |
└─taskName | string | No comments found. | - |
└─subTask | int32 | No comments found. | - |
└─parentTaskId | string | No comments found. | - |
└─businessKey | string | No comments found. | - |
└─formName | string | No comments found. | - |
└─targetKey | string | No comments found. | - |
└─taskDefKey | string | No comments found. | - |
└─assigneeId | string | No comments found. | - |
└─assigneeName | string | No comments found. | - |
└─startUserId | string | No comments found. | - |
└─startUserName | string | No comments found. | - |
└─category | string | No comments found. | - |
└─procVars | object | No comments found. | - |
└─taskLocalVars | object | No comments found. | - |
└─deployId | string | No comments found. | - |
└─procDefId | string | No comments found. | - |
└─procDefKey | string | No comments found. | - |
└─procDefName | string | No comments found. | - |
└─procDefVersion | int32 | No comments found. | - |
└─procInsId | string | No comments found. | - |
└─hisProcInsId | string | No comments found. | - |
└─duration | string | No comments found. | - |
└─comment | object | No comments found. | - |
└─type | string | No comments found. | - |
└─comment | string | No comments found. | - |
└─candidate | string | No comments found. | - |
└─createTime | string | No comments found. | - |
└─finishTime | string | No comments found. | - |
└─values | map | No comments found. | - |
└─any object | object | any object. | - |
└─attachmentList | array | No comments found. | - |
└─userCode | string | No comments found. | - |
└─assignee | string | No comments found. | - |
└─candidateUsers | array | No comments found. | - |
└─candidateGroups | array | No comments found. | - |
└─platformSn | string | No comments found. | - |
└─el | string | No comments found. | - |
Response-example:
{
"code": 563,
"msg": "pt2gpx",
"data": {
"page": {
"per": 485,
"size": 10,
"total": 435
},
"list": [
{
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 173,
"parentTaskId": "76",
"businessKey": "er9esl",
"formName": "嘉熙.万",
"targetKey": "qjpmsd",
"taskDefKey": "9rgaqh",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "nx0w3q",
"procVars": {
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 396,
"parentTaskId": "76",
"businessKey": "r135av",
"formName": "嘉熙.万",
"targetKey": "d16sk5",
"taskDefKey": "630zfd",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "nex0wt",
"procVars": {
"waring": "You may have used non-display generics."
},
"taskLocalVars": {
"waring": "You may have used non-display generics."
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "10bdrk",
"procDefName": "嘉熙.万",
"procDefVersion": 183,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "i5rnzf",
"comment": {
"type": "tpgbqg",
"comment": "185te7"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"object": "any object"
}
],
"userCode": "8174",
"assignee": "x2uats",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "p02jy7",
"el": "o1p8ap"
},
"taskLocalVars": {
"taskId": "76",
"taskName": "嘉熙.万",
"subTask": 628,
"parentTaskId": "76",
"businessKey": "h6821t",
"formName": "嘉熙.万",
"targetKey": "4oqjxl",
"taskDefKey": "1kppi0",
"assigneeId": "76",
"assigneeName": "嘉熙.万",
"startUserId": "76",
"startUserName": "嘉熙.万",
"category": "w7vp73",
"procVars": {
"waring": "You may have used non-display generics."
},
"taskLocalVars": {
"waring": "You may have used non-display generics."
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "u66an2",
"procDefName": "嘉熙.万",
"procDefVersion": 360,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "uhfy9u",
"comment": {
"type": "b691jp",
"comment": "67f8zq"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"object": "any object"
}
],
"userCode": "8174",
"assignee": "c8jibp",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "gefpfc",
"el": "s4ohoi"
},
"deployId": "76",
"procDefId": "76",
"procDefKey": "jwrv43",
"procDefName": "嘉熙.万",
"procDefVersion": 836,
"procInsId": "76",
"hisProcInsId": "76",
"duration": "wj3kvl",
"comment": {
"type": "suh9wd",
"comment": "7a7b2u"
},
"candidate": "2021-12-01",
"createTime": "2021-12-01 16:18:41",
"finishTime": "2021-12-01 16:18:41",
"values": {
"mapKey": {}
},
"attachmentList": [
{
"$ref": ".."
}
],
"userCode": "8174",
"assignee": "128rzt",
"candidateUsers": [
{
"$ref": ".."
}
],
"candidateGroups": [
{
"$ref": ".."
}
],
"platformSn": "x9894y",
"el": "frrm2l"
}
]
}
}
3.5. 获取流程变量
Type: POST
Content-Type: application/json; charset=utf-8
Description: 获取流程变量
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
platformSn | string | No comments found. | false | - |
variables | map | No comments found. | false | - |
└─any object | object | any object. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/processVariables --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "4osmg0",
"variables": {
"mapKey": {}
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 259,
"msg": "s4leou",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
}
3.6. 设置流程变量
Type: POST
Content-Type: application/json; charset=utf-8
Description: 设置流程变量
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
platformSn | string | No comments found. | false | - |
variables | map | No comments found. | false | - |
└─any object | object | any object. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/setProcessVariables --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "dxkyus",
"variables": {
"mapKey": {}
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
└─any object | object | any object. | - |
Response-example:
{
"code": 9,
"msg": "5u9qw5",
"data": {
"mapKey": {
"waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
}
}
}
3.7. 撤回流程
Type: POST
Content-Type: application/json; charset=utf-8
Description: 撤回流程
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/revokeProcess --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
]
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 937,
"msg": "s5xmmw",
"data": {
"waring": "You may have used non-display generics."
}
}
3.8. 取消申请
Type: POST
Content-Type: application/json; charset=utf-8
Description: 取消申请
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
platformSn | string | No comments found. | false | - |
variables | map | No comments found. | false | - |
└─any object | object | any object. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/stopProcess --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "bejky5",
"variables": {
"mapKey": {}
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 513,
"msg": "b3zgo5",
"data": {
"waring": "You may have used non-display generics."
}
}
3.9. 审批任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 审批任务
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
formTitle | string | No comments found. | false | - |
variables | map | No comments found. | false | - |
└─any object | object | any object. | false | - |
attachments | array | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/complete --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"formTitle": "ip868q",
"variables": {
"mapKey": {}
},
"attachments": [
{
"object": "any object"
}
]
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 659,
"msg": "9avumj",
"data": "fzmjjn"
}
3.10. 驳回任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 驳回任务
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/reject --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
]
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 978,
"msg": "xatsz9",
"data": {
"waring": "You may have used non-display generics."
}
}
3.11. 退回任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 退回任务
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/return --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
]
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 585,
"msg": "shasaw",
"data": {
"waring": "You may have used non-display generics."
}
}
3.12. 删除任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 删除任务
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/delete --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
]
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 258,
"msg": "lecdr7",
"data": "yq6h0z"
}
3.13. 委派任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 委派任务
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
delegateUserCode | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/delegate --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"delegateUserCode": "8174"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 160,
"msg": "8ym5us",
"data": "ehqz53"
}
3.14. 转办任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 转办任务
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
turnToUserId | string | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/assign --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"turnToUserId": "76"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 994,
"msg": "uijjb5",
"data": {
"waring": "You may have used non-display generics."
}
}
3.15. 加签任务
Type: POST
Content-Type: application/json; charset=utf-8
Description: 加签任务
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
addSignUserList | array | No comments found. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/addSign --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"addSignUserList": [
{
"object": "any object"
}
]
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
Response-example:
{
"code": 46,
"msg": "wkix1x",
"data": "xyb82m"
}
3.16. 获取所有可回退的节点
Type: POST
Content-Type: application/json; charset=utf-8
Description: 获取所有可回退的节点
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
platformSn | string | No comments found. | false | - |
variables | map | No comments found. | false | - |
└─any object | object | any object. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/findReturnTaskList --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "rhgg7w",
"variables": {
"mapKey": {}
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | array | 响应数据 | - |
└─id | string | No comments found. | - |
└─name | string | No comments found. | - |
└─tenantId | string | No comments found. | - |
Response-example:
{
"code": 297,
"msg": "url90g",
"data": [
{
"id": "76",
"name": "嘉熙.万",
"tenantId": "76"
}
]
}
3.17. 获取下一节点
Type: POST
Content-Type: application/json; charset=utf-8
Description: 获取下一节点
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
taskId | string | No comments found. | false | - |
processInstanceId | string | No comments found. | false | - |
activityId | string | No comments found. | false | - |
activityName | string | No comments found. | false | - |
processStatusEnum | enum | No comments found. | false | - |
userCode | string | No comments found. | false | - |
message | string | No comments found. | false | - |
commentTypeEnum | enum | No comments found. | false | - |
candidateUsers | array | No comments found. | false | - |
candidateGroups | array | No comments found. | false | - |
platformSn | string | No comments found. | false | - |
variables | map | No comments found. | false | - |
└─any object | object | any object. | false | - |
Request-example:
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -i http://localhost:17011/api/flow/task/nextFlowNode --data '{
"taskId": "76",
"processInstanceId": "76",
"activityId": "76",
"activityName": "嘉熙.万",
"processStatusEnum": "SPZ",
"userCode": "8174",
"message": "success",
"commentTypeEnum": "SP",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
],
"platformSn": "vi3mah",
"variables": {
"mapKey": {}
}
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code | int32 | 结果编码 | - |
msg | string | 结果描述 | - |
data | object | 响应数据 | - |
└─type | string | No comments found. | - |
└─dateType | string | No comments found. | - |
└─vars | string | No comments found. | - |
└─name | string | No comments found. | - |
└─assignee | string | No comments found. | - |
└─candidateUsers | array | No comments found. | - |
└─candidateGroups | array | No comments found. | - |
Response-example:
{
"code": 98,
"msg": "551bpr",
"data": {
"type": "gsr1rn",
"dateType": "3whviz",
"vars": "p6gll6",
"name": "嘉熙.万",
"assignee": "nwzj7v",
"candidateUsers": [
{
"object": "any object"
}
],
"candidateGroups": [
{
"object": "any object"
}
]
}
}
4. 错误码列表
Error code | Description |
---|---|
200 | ok |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
415 | Unsupported Media Type |
500 | Internal Server Error |
502 | Bad Gateway |
503 | Service Unavailable |