VersionUpdate TimeStatusAuthorDescription

v2021-10-19 10:29:08

2021-10-19 10:29:08

auto

@finegirl

Created by smart-doc

1. 流程定义部署接口类

1.1. 流程部署列表查询

Type: POST

Content-Type: application/json; charset=utf-8

Description: 流程部署列表查询

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 684,
    "size": 10,
    "total": 955
  },
  "query": {
    "platformSn": "m9shgg",
    "userCode": "217",
    "deployId": "79",
    "processInstanceId": "79",
    "candidateUsers": [
      "n85v6k"
    ],
    "candidateGroups": [
      "q0haof"
    ]
  }
}'

Response-fields:

FieldTypeDescriptionSince

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": 84,
  "msg": "rec8ya",
  "data": {
    "page": {
      "per": 73,
      "size": 10,
      "total": 49
    },
    "list": [
      {
        "id": "79",
        "name": "明.杜",
        "key": "vqtnyt",
        "category": "0qw14i",
        "version": 889,
        "deploymentId": "79",
        "suspensionState": 0,
        "deploymentTime": "2021-10-19 10:29:12"
      }
    ]
  }
}

1.2. 激活或挂起流程定义(已经部署)

Type: POST

Content-Type: application/json; charset=utf-8

Description: 激活或挂起流程定义(已经部署)

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "l4f4cf",
  "deployId": "79",
  "state": 0
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 843,
  "msg": "xbjwh5",
  "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:

ParameterTypeDescriptionRequiredSince

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": "nhduen",
  "deployId": "79",
  "state": 0
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 497,
  "msg": "2n3rwc",
  "data": "nxklrk"
}

1.4. 根据流程定义 ID 获取xml

Type: POST

Content-Type: application/json; charset=utf-8

Description: 根据流程定义 ID 获取xml

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "lq2s0n",
  "deployId": "79",
  "state": 0
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 541,
  "msg": "3hw3do",
  "data": "xea5wd"
}

2. 工作流流程对外服务接口

2.1. 启动流程

Type: POST

Content-Type: application/json; charset=utf-8

Description: 启动流程

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "v21ll1",
  "businessKey": "9ynncx",
  "formName": "明.杜",
  "variables": {
    "mapKey": {}
  },
  "userCode": "217",
  "platformSn": "bl8hkh",
  "creator": "b16f5d"
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 362,
  "msg": "53gp6b",
  "data": "9f9o0m"
}

2.2. 获取el表达式

Type: POST

Content-Type: application/json; charset=utf-8

Description: 获取el表达式

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "7etrz7",
  "businessKey": "2dw2e8",
  "formName": "明.杜",
  "variables": {
    "mapKey": {}
  },
  "userCode": "217",
  "platformSn": "gn2itn",
  "creator": "y4rjxy"
}'

Response-fields:

FieldTypeDescriptionSince

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": 674,
  "msg": "1731f4",
  "data": [
    {
      "taskId": "79",
      "userId": "79",
      "comment": "fwj523",
      "instanceId": "79",
      "targetKey": "pycxbm",
      "name": "明.杜",
      "values": {
        "mapKey": {}
      },
      "assignee": "8wuk3o",
      "candidateUsers": [
        {
          "object": "any object"
        }
      ],
      "candidateGroups": [
        {
          "object": "any object"
        }
      ],
      "tenantId": "79",
      "el": "rl4yhi",
      "multiple": 527
    }
  ]
}

2.3. 激活或挂起流程实例

Type: POST

Content-Type: application/json; charset=utf-8

Description: 激活或挂起流程实例

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "217",
  "processInstanceId": "79",
  "suspensionState": 0
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 306,
  "msg": "pcmgzb",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

2.4. 终止流程

Type: POST

Content-Type: application/json; charset=utf-8

Description: 终止流程

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "217",
  "processInstanceId": "79"
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 587,
  "msg": "9xg03f",
  "data": "s634to"
}

2.5. 删除流程

Type: POST

Content-Type: application/json; charset=utf-8

Description: 删除流程

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "217",
  "processInstanceId": "79",
  "deleteReason": "li5t7t"
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 356,
  "msg": "3d7x39",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

2.6. 获取流程执行过程

Type: POST

Content-Type: application/json; charset=utf-8

Description: 获取流程执行过程

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "217",
  "processInstanceId": "79"
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

array

响应数据

-

└─key

string

No comments found.

-

└─completed

boolean

No comments found.

-

Response-example:

{
  "code": 968,
  "msg": "2hfxp7",
  "data": [
    {
      "key": "qjxjwz",
      "completed": true
    }
  ]
}

2.7. 根据流程实例ID 获取当前流程运行情况 返回BASE64图片

Type: POST

Content-Type: application/json; charset=utf-8

Description: 根据流程实例ID 获取当前流程运行情况 返回BASE64图片

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "217",
  "processInstanceId": "79"
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 310,
  "msg": "l5zams",
  "data": "6liiju"
}

3. 工作流任务对外服务接口

3.1. 我发起的流程

Type: POST

Content-Type: application/json; charset=utf-8

Description: 我发起的流程

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 507,
    "size": 10,
    "total": 216
  },
  "query": {
    "platformSn": "7uk5ku",
    "userCode": "217",
    "deployId": "79",
    "processInstanceId": "79",
    "candidateUsers": [
      "xljyif"
    ],
    "candidateGroups": [
      "iax8w6"
    ]
  }
}'

Response-fields:

FieldTypeDescriptionSince

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": 866,
  "msg": "zav1tn",
  "data": {
    "page": {
      "per": 887,
      "size": 10,
      "total": 68
    },
    "list": [
      {
        "taskId": "79",
        "taskName": "明.杜",
        "subTask": 108,
        "parentTaskId": "79",
        "businessKey": "mvhnt7",
        "formName": "明.杜",
        "targetKey": "45wx8u",
        "taskDefKey": "lrbh4f",
        "assigneeId": "79",
        "assigneeName": "明.杜",
        "startUserId": "79",
        "startUserName": "明.杜",
        "category": "49chu5",
        "procVars": {
          "taskId": "79",
          "taskName": "明.杜",
          "subTask": 615,
          "parentTaskId": "79",
          "businessKey": "9eqs10",
          "formName": "明.杜",
          "targetKey": "6cohxv",
          "taskDefKey": "defi3o",
          "assigneeId": "79",
          "assigneeName": "明.杜",
          "startUserId": "79",
          "startUserName": "明.杜",
          "category": "cqev4s",
          "procVars": {
            "waring": "You may have used non-display generics."
          },
          "taskLocalVars": {
            "waring": "You may have used non-display generics."
          },
          "deployId": "79",
          "procDefId": "79",
          "procDefKey": "49gcki",
          "procDefName": "明.杜",
          "procDefVersion": 165,
          "procInsId": "79",
          "hisProcInsId": "79",
          "duration": "qf26ax",
          "comment": {
            "type": "4avdlu",
            "comment": "6pkxde"
          },
          "candidate": "2021-10-19",
          "createTime": "2021-10-19 10:29:13",
          "finishTime": "2021-10-19 10:29:13",
          "values": {
            "mapKey": {}
          },
          "attachmentList": [
            {
              "object": "any object"
            }
          ],
          "userCode": "217",
          "assignee": "pziowy",
          "candidateUsers": [
            {
              "object": "any object"
            }
          ],
          "candidateGroups": [
            {
              "object": "any object"
            }
          ],
          "platformSn": "awtth2",
          "el": "f335ux"
        },
        "taskLocalVars": {
          "taskId": "79",
          "taskName": "明.杜",
          "subTask": 964,
          "parentTaskId": "79",
          "businessKey": "huhugh",
          "formName": "明.杜",
          "targetKey": "89y1dt",
          "taskDefKey": "4k8f9w",
          "assigneeId": "79",
          "assigneeName": "明.杜",
          "startUserId": "79",
          "startUserName": "明.杜",
          "category": "lf3ssu",
          "procVars": {
            "waring": "You may have used non-display generics."
          },
          "taskLocalVars": {
            "waring": "You may have used non-display generics."
          },
          "deployId": "79",
          "procDefId": "79",
          "procDefKey": "joa3nh",
          "procDefName": "明.杜",
          "procDefVersion": 362,
          "procInsId": "79",
          "hisProcInsId": "79",
          "duration": "znuwxs",
          "comment": {
            "type": "6ye1wo",
            "comment": "is8uz4"
          },
          "candidate": "2021-10-19",
          "createTime": "2021-10-19 10:29:13",
          "finishTime": "2021-10-19 10:29:13",
          "values": {
            "mapKey": {}
          },
          "attachmentList": [
            {
              "object": "any object"
            }
          ],
          "userCode": "217",
          "assignee": "lppokm",
          "candidateUsers": [
            {
              "object": "any object"
            }
          ],
          "candidateGroups": [
            {
              "object": "any object"
            }
          ],
          "platformSn": "0xrwn6",
          "el": "4ivc8w"
        },
        "deployId": "79",
        "procDefId": "79",
        "procDefKey": "c5812u",
        "procDefName": "明.杜",
        "procDefVersion": 769,
        "procInsId": "79",
        "hisProcInsId": "79",
        "duration": "l05ahe",
        "comment": {
          "type": "p1wqxk",
          "comment": "m3dudt"
        },
        "candidate": "2021-10-19",
        "createTime": "2021-10-19 10:29:13",
        "finishTime": "2021-10-19 10:29:13",
        "values": {
          "mapKey": {}
        },
        "attachmentList": [
          {
            "$ref": ".."
          }
        ],
        "userCode": "217",
        "assignee": "glvgjr",
        "candidateUsers": [
          {
            "$ref": ".."
          }
        ],
        "candidateGroups": [
          {
            "$ref": ".."
          }
        ],
        "platformSn": "rnfmj4",
        "el": "g4rs1t"
      }
    ]
  }
}

3.2. 获取待办列表获取的列表需要和业务系统数据合并

Type: POST

Content-Type: application/json; charset=utf-8

Description: 获取待办列表 获取的列表需要和业务系统数据合并

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 572,
    "size": 10,
    "total": 219
  },
  "query": {
    "platformSn": "nl8h9g",
    "userCode": "217",
    "deployId": "79",
    "processInstanceId": "79",
    "candidateUsers": [
      "6w9dd3"
    ],
    "candidateGroups": [
      "u9pw3v"
    ]
  }
}'

Response-fields:

FieldTypeDescriptionSince

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": 209,
  "msg": "fpvi7v",
  "data": {
    "page": {
      "per": 323,
      "size": 10,
      "total": 532
    },
    "list": [
      {
        "taskId": "79",
        "taskName": "明.杜",
        "subTask": 64,
        "parentTaskId": "79",
        "businessKey": "td43ae",
        "formName": "明.杜",
        "targetKey": "tenaqj",
        "taskDefKey": "ll1py6",
        "assigneeId": "79",
        "assigneeName": "明.杜",
        "startUserId": "79",
        "startUserName": "明.杜",
        "category": "mqtidb",
        "procVars": {
          "taskId": "79",
          "taskName": "明.杜",
          "subTask": 979,
          "parentTaskId": "79",
          "businessKey": "wkqd2c",
          "formName": "明.杜",
          "targetKey": "spfyiw",
          "taskDefKey": "f4z2ru",
          "assigneeId": "79",
          "assigneeName": "明.杜",
          "startUserId": "79",
          "startUserName": "明.杜",
          "category": "vu57wx",
          "procVars": {
            "waring": "You may have used non-display generics."
          },
          "taskLocalVars": {
            "waring": "You may have used non-display generics."
          },
          "deployId": "79",
          "procDefId": "79",
          "procDefKey": "85i9ae",
          "procDefName": "明.杜",
          "procDefVersion": 957,
          "procInsId": "79",
          "hisProcInsId": "79",
          "duration": "sfkkxm",
          "comment": {
            "type": "gtrziw",
            "comment": "mw11r1"
          },
          "candidate": "2021-10-19",
          "createTime": "2021-10-19 10:29:13",
          "finishTime": "2021-10-19 10:29:13",
          "values": {
            "mapKey": {}
          },
          "attachmentList": [
            {
              "object": "any object"
            }
          ],
          "userCode": "217",
          "assignee": "r4aecx",
          "candidateUsers": [
            {
              "object": "any object"
            }
          ],
          "candidateGroups": [
            {
              "object": "any object"
            }
          ],
          "platformSn": "f7ckus",
          "el": "zko8yh"
        },
        "taskLocalVars": {
          "taskId": "79",
          "taskName": "明.杜",
          "subTask": 485,
          "parentTaskId": "79",
          "businessKey": "hz6ia2",
          "formName": "明.杜",
          "targetKey": "jrvz4m",
          "taskDefKey": "yvjvbo",
          "assigneeId": "79",
          "assigneeName": "明.杜",
          "startUserId": "79",
          "startUserName": "明.杜",
          "category": "7775o8",
          "procVars": {
            "waring": "You may have used non-display generics."
          },
          "taskLocalVars": {
            "waring": "You may have used non-display generics."
          },
          "deployId": "79",
          "procDefId": "79",
          "procDefKey": "m753rq",
          "procDefName": "明.杜",
          "procDefVersion": 743,
          "procInsId": "79",
          "hisProcInsId": "79",
          "duration": "4dcf5b",
          "comment": {
            "type": "t9wiz3",
            "comment": "vvc2xc"
          },
          "candidate": "2021-10-19",
          "createTime": "2021-10-19 10:29:13",
          "finishTime": "2021-10-19 10:29:13",
          "values": {
            "mapKey": {}
          },
          "attachmentList": [
            {
              "object": "any object"
            }
          ],
          "userCode": "217",
          "assignee": "ij77ve",
          "candidateUsers": [
            {
              "object": "any object"
            }
          ],
          "candidateGroups": [
            {
              "object": "any object"
            }
          ],
          "platformSn": "sqc3bj",
          "el": "ck0cpr"
        },
        "deployId": "79",
        "procDefId": "79",
        "procDefKey": "ys38cg",
        "procDefName": "明.杜",
        "procDefVersion": 258,
        "procInsId": "79",
        "hisProcInsId": "79",
        "duration": "epsli7",
        "comment": {
          "type": "6jc9pq",
          "comment": "qtnzha"
        },
        "candidate": "2021-10-19",
        "createTime": "2021-10-19 10:29:13",
        "finishTime": "2021-10-19 10:29:13",
        "values": {
          "mapKey": {}
        },
        "attachmentList": [
          {
            "$ref": ".."
          }
        ],
        "userCode": "217",
        "assignee": "lsr19z",
        "candidateUsers": [
          {
            "$ref": ".."
          }
        ],
        "candidateGroups": [
          {
            "$ref": ".."
          }
        ],
        "platformSn": "rbvc63",
        "el": "5r72ka"
      }
    ]
  }
}

3.3. 获取已办任务获取的列表需要和业务系统数据合并

Type: POST

Content-Type: application/json; charset=utf-8

Description: 获取已办任务 获取的列表需要和业务系统数据合并

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 828,
    "size": 10,
    "total": 82
  },
  "query": {
    "platformSn": "oi8td0",
    "userCode": "217",
    "deployId": "79",
    "processInstanceId": "79",
    "candidateUsers": [
      "1bcd2r"
    ],
    "candidateGroups": [
      "9c40nm"
    ]
  }
}'

Response-fields:

FieldTypeDescriptionSince

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": 40,
  "msg": "1katf3",
  "data": {
    "page": {
      "per": 523,
      "size": 10,
      "total": 998
    },
    "list": [
      {
        "taskId": "79",
        "taskName": "明.杜",
        "subTask": 227,
        "parentTaskId": "79",
        "businessKey": "dtxvfr",
        "formName": "明.杜",
        "targetKey": "ppmmvx",
        "taskDefKey": "h0r9o3",
        "assigneeId": "79",
        "assigneeName": "明.杜",
        "startUserId": "79",
        "startUserName": "明.杜",
        "category": "6054z0",
        "procVars": {
          "taskId": "79",
          "taskName": "明.杜",
          "subTask": 863,
          "parentTaskId": "79",
          "businessKey": "0wtxd2",
          "formName": "明.杜",
          "targetKey": "57ev3s",
          "taskDefKey": "f9gkma",
          "assigneeId": "79",
          "assigneeName": "明.杜",
          "startUserId": "79",
          "startUserName": "明.杜",
          "category": "clizy9",
          "procVars": {
            "waring": "You may have used non-display generics."
          },
          "taskLocalVars": {
            "waring": "You may have used non-display generics."
          },
          "deployId": "79",
          "procDefId": "79",
          "procDefKey": "eynj0w",
          "procDefName": "明.杜",
          "procDefVersion": 574,
          "procInsId": "79",
          "hisProcInsId": "79",
          "duration": "hcjogb",
          "comment": {
            "type": "dshhqi",
            "comment": "wrw17j"
          },
          "candidate": "2021-10-19",
          "createTime": "2021-10-19 10:29:13",
          "finishTime": "2021-10-19 10:29:13",
          "values": {
            "mapKey": {}
          },
          "attachmentList": [
            {
              "object": "any object"
            }
          ],
          "userCode": "217",
          "assignee": "m7w5ye",
          "candidateUsers": [
            {
              "object": "any object"
            }
          ],
          "candidateGroups": [
            {
              "object": "any object"
            }
          ],
          "platformSn": "8eo6hc",
          "el": "1cbqpz"
        },
        "taskLocalVars": {
          "taskId": "79",
          "taskName": "明.杜",
          "subTask": 298,
          "parentTaskId": "79",
          "businessKey": "8hbaz0",
          "formName": "明.杜",
          "targetKey": "mmt1wq",
          "taskDefKey": "by9qco",
          "assigneeId": "79",
          "assigneeName": "明.杜",
          "startUserId": "79",
          "startUserName": "明.杜",
          "category": "qkfkt0",
          "procVars": {
            "waring": "You may have used non-display generics."
          },
          "taskLocalVars": {
            "waring": "You may have used non-display generics."
          },
          "deployId": "79",
          "procDefId": "79",
          "procDefKey": "2eswxx",
          "procDefName": "明.杜",
          "procDefVersion": 230,
          "procInsId": "79",
          "hisProcInsId": "79",
          "duration": "tajwqb",
          "comment": {
            "type": "bt2rki",
            "comment": "eu4h0z"
          },
          "candidate": "2021-10-19",
          "createTime": "2021-10-19 10:29:13",
          "finishTime": "2021-10-19 10:29:13",
          "values": {
            "mapKey": {}
          },
          "attachmentList": [
            {
              "object": "any object"
            }
          ],
          "userCode": "217",
          "assignee": "elmnab",
          "candidateUsers": [
            {
              "object": "any object"
            }
          ],
          "candidateGroups": [
            {
              "object": "any object"
            }
          ],
          "platformSn": "eogww2",
          "el": "hh4umu"
        },
        "deployId": "79",
        "procDefId": "79",
        "procDefKey": "v1h5cj",
        "procDefName": "明.杜",
        "procDefVersion": 24,
        "procInsId": "79",
        "hisProcInsId": "79",
        "duration": "e6puc5",
        "comment": {
          "type": "mcfa5q",
          "comment": "l1gvtu"
        },
        "candidate": "2021-10-19",
        "createTime": "2021-10-19 10:29:13",
        "finishTime": "2021-10-19 10:29:13",
        "values": {
          "mapKey": {}
        },
        "attachmentList": [
          {
            "$ref": ".."
          }
        ],
        "userCode": "217",
        "assignee": "4f7s9f",
        "candidateUsers": [
          {
            "$ref": ".."
          }
        ],
        "candidateGroups": [
          {
            "$ref": ".."
          }
        ],
        "platformSn": "9z3360",
        "el": "fecr7m"
      }
    ]
  }
}

3.4. 流程历史流转记录

Type: POST

Content-Type: application/json; charset=utf-8

Description: 流程历史流转记录

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": 36,
    "size": 10,
    "total": 930
  },
  "query": {
    "platformSn": "9eybvf",
    "userCode": "217",
    "deployId": "79",
    "processInstanceId": "79",
    "candidateUsers": [
      "sdb7yr"
    ],
    "candidateGroups": [
      "mg6sc9"
    ]
  }
}'

Response-fields:

FieldTypeDescriptionSince

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": 293,
  "msg": "56jukx",
  "data": {
    "page": {
      "per": 416,
      "size": 10,
      "total": 858
    },
    "list": [
      {
        "taskId": "79",
        "taskName": "明.杜",
        "subTask": 843,
        "parentTaskId": "79",
        "businessKey": "xwxam0",
        "formName": "明.杜",
        "targetKey": "sr7xia",
        "taskDefKey": "la92au",
        "assigneeId": "79",
        "assigneeName": "明.杜",
        "startUserId": "79",
        "startUserName": "明.杜",
        "category": "ukcsrk",
        "procVars": {
          "taskId": "79",
          "taskName": "明.杜",
          "subTask": 594,
          "parentTaskId": "79",
          "businessKey": "drh0vg",
          "formName": "明.杜",
          "targetKey": "quik1i",
          "taskDefKey": "yri8gg",
          "assigneeId": "79",
          "assigneeName": "明.杜",
          "startUserId": "79",
          "startUserName": "明.杜",
          "category": "72emr5",
          "procVars": {
            "waring": "You may have used non-display generics."
          },
          "taskLocalVars": {
            "waring": "You may have used non-display generics."
          },
          "deployId": "79",
          "procDefId": "79",
          "procDefKey": "dbc0jq",
          "procDefName": "明.杜",
          "procDefVersion": 917,
          "procInsId": "79",
          "hisProcInsId": "79",
          "duration": "52ritw",
          "comment": {
            "type": "3xjt92",
            "comment": "l6i3iw"
          },
          "candidate": "2021-10-19",
          "createTime": "2021-10-19 10:29:13",
          "finishTime": "2021-10-19 10:29:13",
          "values": {
            "mapKey": {}
          },
          "attachmentList": [
            {
              "object": "any object"
            }
          ],
          "userCode": "217",
          "assignee": "ei84t8",
          "candidateUsers": [
            {
              "object": "any object"
            }
          ],
          "candidateGroups": [
            {
              "object": "any object"
            }
          ],
          "platformSn": "ecdvy0",
          "el": "4yiawb"
        },
        "taskLocalVars": {
          "taskId": "79",
          "taskName": "明.杜",
          "subTask": 982,
          "parentTaskId": "79",
          "businessKey": "8r507k",
          "formName": "明.杜",
          "targetKey": "4qmsxi",
          "taskDefKey": "hbb5wn",
          "assigneeId": "79",
          "assigneeName": "明.杜",
          "startUserId": "79",
          "startUserName": "明.杜",
          "category": "49go2l",
          "procVars": {
            "waring": "You may have used non-display generics."
          },
          "taskLocalVars": {
            "waring": "You may have used non-display generics."
          },
          "deployId": "79",
          "procDefId": "79",
          "procDefKey": "wd5ima",
          "procDefName": "明.杜",
          "procDefVersion": 688,
          "procInsId": "79",
          "hisProcInsId": "79",
          "duration": "txjar2",
          "comment": {
            "type": "28b3me",
            "comment": "nckn7a"
          },
          "candidate": "2021-10-19",
          "createTime": "2021-10-19 10:29:13",
          "finishTime": "2021-10-19 10:29:13",
          "values": {
            "mapKey": {}
          },
          "attachmentList": [
            {
              "object": "any object"
            }
          ],
          "userCode": "217",
          "assignee": "afbbnw",
          "candidateUsers": [
            {
              "object": "any object"
            }
          ],
          "candidateGroups": [
            {
              "object": "any object"
            }
          ],
          "platformSn": "03pot9",
          "el": "z4cdn4"
        },
        "deployId": "79",
        "procDefId": "79",
        "procDefKey": "lejamt",
        "procDefName": "明.杜",
        "procDefVersion": 951,
        "procInsId": "79",
        "hisProcInsId": "79",
        "duration": "pm4pmo",
        "comment": {
          "type": "p01boy",
          "comment": "mc4snc"
        },
        "candidate": "2021-10-19",
        "createTime": "2021-10-19 10:29:13",
        "finishTime": "2021-10-19 10:29:13",
        "values": {
          "mapKey": {}
        },
        "attachmentList": [
          {
            "$ref": ".."
          }
        ],
        "userCode": "217",
        "assignee": "j93lds",
        "candidateUsers": [
          {
            "$ref": ".."
          }
        ],
        "candidateGroups": [
          {
            "$ref": ".."
          }
        ],
        "platformSn": "2cyvdd",
        "el": "35lqqp"
      }
    ]
  }
}

3.5. 获取流程变量

Type: POST

Content-Type: application/json; charset=utf-8

Description: 获取流程变量

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "platformSn": "xl3epn",
  "variables": {
    "mapKey": {}
  }
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

└─any object

object

any object.

-

Response-example:

{
  "code": 959,
  "msg": "vic7dc",
  "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:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "platformSn": "a9p2ru",
  "variables": {
    "mapKey": {}
  }
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

└─any object

object

any object.

-

Response-example:

{
  "code": 900,
  "msg": "gr37gv",
  "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:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ]
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 535,
  "msg": "a974n2",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

3.8. 取消申请

Type: POST

Content-Type: application/json; charset=utf-8

Description: 取消申请

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "platformSn": "skk74z",
  "variables": {
    "mapKey": {}
  }
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 459,
  "msg": "700haa",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

3.9. 审批任务

Type: POST

Content-Type: application/json; charset=utf-8

Description: 审批任务

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "formTitle": "ne94xl",
  "variables": {
    "mapKey": {}
  },
  "attachments": [
    {
      "object": "any object"
    }
  ]
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 936,
  "msg": "m7z0q9",
  "data": "0wl3yy"
}

3.10. 驳回任务

Type: POST

Content-Type: application/json; charset=utf-8

Description: 驳回任务

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ]
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 950,
  "msg": "u830zd",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

3.11. 退回任务

Type: POST

Content-Type: application/json; charset=utf-8

Description: 退回任务

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ]
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 611,
  "msg": "peitfa",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

3.12. 删除任务

Type: POST

Content-Type: application/json; charset=utf-8

Description: 删除任务

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ]
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 313,
  "msg": "abrkht",
  "data": "me78p7"
}

3.13. 委派任务

Type: POST

Content-Type: application/json; charset=utf-8

Description: 委派任务

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "delegateUserCode": "217"
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 262,
  "msg": "vvgynr",
  "data": "6fd1q9"
}

3.14. 转办任务

Type: POST

Content-Type: application/json; charset=utf-8

Description: 转办任务

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "turnToUserId": "79"
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 421,
  "msg": "3191qt",
  "data": {
    "waring": "You may have used non-display generics."
  }
}

3.15. 加签任务

Type: POST

Content-Type: application/json; charset=utf-8

Description: 加签任务

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "addSignUserList": [
    {
      "object": "any object"
    }
  ]
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

object

响应数据

-

Response-example:

{
  "code": 904,
  "msg": "v64w6j",
  "data": "voy983"
}

3.16. 获取所有可回退的节点

Type: POST

Content-Type: application/json; charset=utf-8

Description: 获取所有可回退的节点

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "platformSn": "bmf7sv",
  "variables": {
    "mapKey": {}
  }
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

结果编码

-

msg

string

结果描述

-

data

array

响应数据

-

└─id

string

No comments found.

-

└─name

string

No comments found.

-

└─tenantId

string

No comments found.

-

Response-example:

{
  "code": 788,
  "msg": "0waxgw",
  "data": [
    {
      "id": "79",
      "name": "明.杜",
      "tenantId": "79"
    }
  ]
}

3.17. 获取下一节点

Type: POST

Content-Type: application/json; charset=utf-8

Description: 获取下一节点

Body-parameters:

ParameterTypeDescriptionRequiredSince

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": "79",
  "processInstanceId": "79",
  "activityId": "79",
  "activityName": "明.杜",
  "processStatusEnum": "SPZ",
  "userCode": "217",
  "message": "success",
  "commentTypeEnum": "SP",
  "candidateUsers": [
    {
      "object": "any object"
    }
  ],
  "candidateGroups": [
    {
      "object": "any object"
    }
  ],
  "platformSn": "72rhl6",
  "variables": {
    "mapKey": {}
  }
}'

Response-fields:

FieldTypeDescriptionSince

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": 524,
  "msg": "1wnm2r",
  "data": {
    "type": "04lplo",
    "dateType": "35f9al",
    "vars": "av1vlx",
    "name": "明.杜",
    "assignee": "q18qbz",
    "candidateUsers": [
      {
        "object": "any object"
      }
    ],
    "candidateGroups": [
      {
        "object": "any object"
      }
    ]
  }
}

4. 错误码列表

Error codeDescription

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

Top