实例操作统一接口 - 低代码-BPM平台-v5.15

该接口是实例操作的统一入口，根据actionName 来区分是什么操作。如流程启动，重启实例，撤回，撤销，保存等。在这一章节中会对所有参数及返回值进行详细的介绍，后面具体的操作便不再赘述。返回值根据不同的操作有不同的返回值，有的有数据，有的没数据。返回值中数据包含了实例信息或者任务信息。

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer{{Auth_Token}}

Body 参数application/json

defKey

string

流程定key

可选

使用流程定义KEY启动流程时必填，默认使用主版本

instanceId

string

流程实例ID

可选

启动草稿时，通过实例ID处理动作时

defId

string

流程定义id

可选

使用定义ID是有具体版本

actionName

string

action动作的名字

必需

必填

bizId

string

业务ID

可选

可以通过业务id获取业务数据

data

object

业务数据

可选

json数据可能是内部表的数据结构，也可能是url表单的结构，系统不管在什么情况都会尝试从中获取业务对象信息

presetDestination

string

目标路径

可选

预设的目标路径

presetVariable

object

变量

可选

预设的变量

identityMap

object

任务候选人

可选

预设的任务候选人

opinion

string

意见备注

可选

意见备注

extendConf

string

特殊的配置

可选

特殊的配置，由于插件，动作会有些特殊配置。特别多，都存放于此

示例

{
    "defId": "1625744748191494144",
    "actionName": "reminder",
    "presetDestination": "",
    "opinion": "您好，请您尽快处理任务：${流程标题} ！情况紧急，请见快处理",
    "extendConf": {
        "param": {
            "instId": "1626116165523324928"
        },
        "isUrgencyTask": true,
        "msgType": "email,inner"
    },
    "data": {
        "ddb": {
            "ddwlList": [],
            "qdjl": "张飒",
            "id": "1626116168396423168",
            "mz": "手机",
            "ddje": 1000,
            "_loadMap": {
                "ddb": true,
                "ddwl": true
            }
        }
    },
    "instanceId": "1626116165523324928"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

isOk

boolean

接口调用状态

必需

code

string

接口调用状态码

必需

message

string

接口调用信息

必需

data

object

接口返回的数据

必需

msg

string

必需

示例

{
    "isOk": true,
    "code": "Success",
    "message": "操作成功",
    "data": {
        "id": "1625777148489445376",
        "name": "开始分支",
        "nodeKey": "UserTask2",
        "title": "管理员发起的任务办理测试流程",
        "instId": "1625777146748809216",
        "actTaskId": "1625777148489445376",
        "actExecutionId": "1625777147143073793",
        "defId": "1625744748191494144",
        "statusArr": "normal",
        "assigneeNames": "管理员",
        "priority": 50,
        "supportMobile": 1,
        "taskType": "userTask",
        "taskTypeDeclaringClass": "com.dstz.bpm.api.enums.TaskType",
        "taskTypeKey": "userTask",
        "taskTypeLabelCss": "primary",
        "taskTypeValue": "用户任务",
        "parentId": "",
        "typeCode": "test",
        "createBy": "1",
        "createTime": "2023-02-15 16:40:52",
        "createOrgId": "410054569125740545",
        "updater": "管理员",
        "updateTime": "2023-02-15 16:40:52",
        "updateBy": "1",
        "status": "normal",
        "statusDeclaringClass": "com.dstz.bpm.api.enums.TaskStatus",
        "statusDesc": "普通任务",
        "statusKey": "normal",
        "statusLabelCss": "primary",
        "statusValue": "普通",
        "isDue": false,
        "durMs": 928
    },
    "msg": "操作成功"
}