智慧工单整体架构

工单整体设计

睿智云平台工作流引擎底层API

avatar

返回结果约定：

code: 服务器响应码, 200 代表成功， 非200代表失败。

{

    "code": "200", 
    "message":""

}

1 流程基本操作

API列表

编号 API名称 路径 版本
1.1 部署工作流 /v1/workflow/deployment 1.0
1.2 启动工作流 /v1/workflow/start/{processDefinitionKey} 1.0
1.3 完成工作流当前任务 /v1/workflow/process/{processInstanceId}/{taskKey} 1.0
1.4 删除工作流 /v1/workflow/delete/{processInstanceId} 1.0
1.5 回退工作流 /v1/workflow/task/fallback 1.0
1.6 更新工作流名 /v1/workflow/updateProcessDefin/{procDefID}/{processName} 1.0
1.7 创建流程实例 /v1/workflow/runtime/createFlowInstance/{procDefID} 1.0
1.8 批量将指定的流程实例转单给指定的人员 /v1/workflow/runtime/createFlowInstance/{taskIdList}/{toUserID} 1.0
1.9 根据流程实例ID查询流程实例详情 /v1/workflow/runtime/getProcessInstanceDetail/{processInstanceID} 1.0
1.10 根据流程实例ID查询流程处理过程 /v1/workflow/runtime/getProcessInstanceHistory/{processInstanceID} 1.0
1.11 指派工单给指定的人员 /v1/workflow/runtime/assignProcessInstance/{processInstanceID}/{userID} 1.0
1.12 挂起指定的流程实例 /v1/workflow/runtime/suspendProcessInstance/{processInstanceID} 1.0
1.13 取消指定的流程实例 /v1/workflow/runtime/revokeProcessInstance/{processInstanceID} 1.0

URL: /v1/workflow/deployment

POST:

body:

属性 数据类型 说明
processDefinitionXml 平台定义XML格式

API调用

1.1: 部署工作流

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/deployment

方法：POST

请求参数

名称 位置 类型 必填 描述
name body string y 流程名称
processDefinitionXml body int y 流程定义文件流

请求Body描述(非Form表单数据)

{
    "name": "",
    "processDefinitionXml": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.2: 启动工作流

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/start/{processDefinitionKey}

方法：POST

请求参数

名称 位置 类型 必填 描述
body body json y 流程参数
processDefinitionKey body int y 流程定义ID

请求Body描述(非Form表单数据)

{
    "xxx": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
id 流程实例ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
      "id": ""
  }
}

1.3: 完成工作流当前任务

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/process/{processInstanceId}/{taskKey}

方法：POST

请求参数

名称 位置 类型 必填 描述
body body json y 流程参数
processInstanceId body string y 流程定义ID
taskKey body string y 任务ID

请求Body描述(非Form表单数据)

{
    "xxx": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
id 流程实例ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.4: 删除工作流

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/delete/{processInstanceId}

方法：POST

请求参数

名称 位置 类型 必填 描述
processInstanceId body string y 流程定义ID

请求Body描述(非Form表单数据)

{
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
id 流程实例ID
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.5: 回退工作流

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/task/fallback

方法：POST

请求参数

名称 位置 类型 必填 描述
processInstanceId body string y 流程定义ID
taskKey body string y 任务ID
reason body string y 回退原因

请求Body描述(非Form表单数据)

{
    "processInstanceId": "",
    "taskKey": "",
    "reason": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
id 流程实例ID
返回结果示例

1.6: 更新工作流名

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/delupdateProcessDefinete/{procDefID}/{processName}

方法：POST

请求参数

名称 位置 类型 必填 描述
procDefID body string y 流程定义ID
processName body string y 新的流程名

请求Body描述(非Form表单数据)

{
    "procDefID": "",
    "processName": "",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
返回结果示例
{
  "code": "200",
  "message": "success",
}

1.7: 创建流程实例

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/runtime/createFlowInstance/{procDefID}

方法：POST

请求参数

名称 位置 类型 必填 描述
procDefID body string y 流程定义ID

请求Body描述(非Form表单数据)

{
    "procDefID": ""
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
返回结果示例
{
  "code": "200",
  "message": "success",
}

1.8: 批量将指定的流程实例转单给指定的人员

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/runtime/createFlowInstance/{taskIdList}/{toUserID}

方法：POST

请求参数

名称 位置 类型 必填 描述
taskIdList body string y 待转单的流程实例id列表
toUserID body string y 受单人员id

请求Body描述(非Form表单数据)

{
    "taskIdList": "",
    "toUserID": "",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
返回结果示例
{
  "code": "200",
  "message": "success",
}

1.9: 根据流程实例ID查询流程实例详情

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/runtime/getProcessInstanceDetail/{processInstanceID}

方法：POST

请求参数

名称 位置 类型 必填 描述
processInstanceID body string y 流程实例ID

请求Body描述(非Form表单数据)

{
    "processInstanceID": "",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 object 是 实例对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.10: 根据流程实例ID查询流程处理过程

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/runtime/getProcessInstanceHistory/{processInstanceID}

方法：POST

请求参数

名称 位置 类型 必填 描述
processInstanceID body string y 流程实例ID

请求Body描述(非Form表单数据)

{
    "processInstanceID": "",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 object 是 实例对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.11: 指派工单给指定的人员

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/runtime/assignProcessInstance/{processInstanceID}/{userID}

方法：POST

请求参数

名称 位置 类型 必填 描述
processInstanceID body string y 流程实例ID
userID body string y 受单人ID

请求Body描述(非Form表单数据)

{
    "processInstanceID": "",
    "userID": "",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
返回结果示例
{
  "code": "200",
  "message": "success",
}

1.12: 挂起指定的流程实例

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/runtime/suspendProcessInstance/{processInstanceID}

方法：POST

请求参数

名称 位置 类型 必填 描述
processInstanceID body string y 流程实例ID

请求Body描述(非Form表单数据)

{
    "processInstanceID": "",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
返回结果示例
{
  "code": "200",
  "message": "success",
}

1.13: 取消指定的流程实例

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/runtime/revokeProcessInstance/{processInstanceID}

方法：POST

请求参数

名称 位置 类型 必填 描述
processInstanceID body string y 流程实例ID

请求Body描述(非Form表单数据)

{
    "processInstanceID": "",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
返回结果示例
{
  "code": "200",
  "message": "success",
}

1.14: 由流程定义key获取流程实例

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/instance/get/{processDefinitionKey}

方法：get

路径参数

名称 位置 类型 必填 描述
processDefinitionKey URL string y 流程定义key 
{
    "processDefinitionKey": "0122uuedkkue",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识

| message | 顶层 | STRING | 是 | 响应消息文本

返回结果示例
{
  "code": "200",
  "message": "success",
  "data": "返回CmmnModelInstance对象"
}

1.15: 查询流程定义

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/processDefinitions/query/{processDefinitionKey}

方法：get

路径参数

名称 位置 类型 必填 描述
processDefinitionKey URL string y 流程定义key 
{
    "processDefinitionKey": "0122uuedkkue",
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识

| message | 顶层 | STRING | 是 | 响应消息文本

返回结果示例
{
  "code": "200",
  "message": "success",
  "data":  {
      "result":[ {ProcessDefinition对象},... ]

  }
}

1.16: 查询流程定义

描述 支持变量的形式执行更加灵活的查询

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/workflow/processInstances/query/exactly

方法：POST

路径参数

名称 位置 类型 必填 描述
processDefinitionKey body string y 流程定义key
variables body JSONArray N 根据流程变量查询 
{
    "processDefinitionKey": "0122uuedkkue",
  "variables":[{"key":"name", "value":"Jack", "operator": "like" },...]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识

| message | 顶层 | STRING | 是 | 响应消息文本

返回结果示例
{
  "code": "200",
  "message": "success",
  "data":  {
      "result":[ {ProcessDefinition对象},... ]

  }
}

1.17 流程会签

待续

1.18 创建流程决策表

待续

Copyright © www.remacsmart.com/ 2021 all right reserved，powered by Gitbook该文件修订时间： 2022-02-11 15:02:21

results matching ""

    No results matching ""