文档中心
搜索
Ask AI
全部文档
文档中心开发者中心API 文档工作流

工作流

DeepFlow 服务（示例：deepflow-server3-0）。完整 URL：https://{host}/deepfos-server/deepflow-server3-0 + 下文 Path（相对路径）。

规范：OpenAPI / Swagger UI。

鉴权：多数接口需 Header space、app、user。会话凭证在部分环境为 cookie，在部分环境（如 Python SDK 直连服务）为 token，二者通常不叠加使用，以实际网关/SDK 为准。勿泄露真实 Cookie / Token。

约定

项

说明

Content-Type

除 GET 外一般为 application/json

status（分页 Body）

OpenAPI 标必填；流程常用 InProgress、Completed、Terminated；多值是否逗号分隔依环境

经网关时的统一响应包层

经 https://{host}/deepfos-server/deepflow-server3-0/... 调用时，HTTP 200 的 JSON 根级常为：

根字段

类型

说明

status

boolean

true 表示业务成功（data 为有效负载）；false 时多为业务校验/规则失败

data

any

成功时为下表各接口所述结构；失败时常为 null

code

integer

平台错误码；成功时多为 0

message

string

失败原因文案；成功时多为 null

下文各接口的 「响应」字段表 描述的是 解包后的 data（即与 OpenAPI 模型一致的一层）。响应示例 采用线上常见的 带 status/data 包层 写法；若你直连未包层的微服务端口，则 Body 可能等于 data。

流程启动

启动流程

拉起一条流程实例，返回业务键与实例 ID。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/api/launch

Header 参数

参数名

类型

必填

说明

space

string

是

空间 ID

app

string

是

应用 ID

user

string

是

用户 ID

cookie

string

是

登录会话 Cookie

Body — ProcessLaunchDTO

字段名

类型

必填

说明

elementDetail

object

否

工作流元素定位，结构见下表「元素定位」

paramMap

object

否

启动参数键值；键须与工作流元素上配置的参数编码一致

comment

string

否

备注

filePath

string

否

附件等扩展；多数 REST 场景为 null，以产品版本为准

元素定位（ProcessStartDTO，嵌套于 elementDetail）

字段名

类型

必填

说明

elementName

string

是

工作流元素编码

folderId

string

否

目录 ID，与 path 二选一

path

string

否

元素路径，与 folderId 二选一

响应 — HTTP 200，Body 类型 LaunchReturnVO

字段名

类型

说明

businessKey

string

业务唯一键

procInstId

string

流程实例 ID

paramMap

object

本次启动参数快照

请求示例

Copy
{
  "elementDetail": { "elementName": "single_approve", "folderId": "DIR1f57bbb34296", "path": null },
  "paramMap": { "input1_str": "20250904", "input3_int": 1, "input2": "1778214583.7383173" },
  "comment": "数据流调用",
  "filePath": null
}

响应示例（成功，经网关包层）

Copy
{
  "status": true,
  "data": {
    "businessKey": "doc-uniq|1|1778215031.2919302",
    "procInstId": "00000000-0000-0000-0000-0000000000c3",
    "paramMap": {
      "input1_str": "doc-uniq",
      "input3_int": 1,
      "input2": "1778215031.2919302"
    }
  },
  "code": 0,
  "message": null
}

响应示例（失败：业务键冲突，经网关包层）

Copy
{
  "status": false,
  "data": null,
  "code": 42,
  "message": "已存在业务键相同的活跃流程，不允许重复发起"
}

批量启动流程

一次提交多组启动参数；每组必须带 alias。适用于单次启动间隔受限等场景。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/api/launch/batch

Header 参数

参数名

类型

必填

说明

space

string

是

空间 ID

app

string

是

应用 ID

user

string

是

用户 ID

cookie

string

是

登录会话 Cookie

Body — ProcessLaunchMultipleDTO

字段名

类型

必填

说明

elementDetail

object

否

元素定位，结构见下表「元素定位」

multipleParams

array

否

每组一项 ProcessStartMultipleDTO

元素定位（ProcessStartDTO）

字段名

类型

必填

说明

elementName

string

是

工作流元素编码

folderId

string

否

目录 ID，与 path 二选一

path

string

否

元素路径，与 folderId 二选一

ProcessStartMultipleDTO（multipleParams 数组元素）

字段名

类型

必填

说明

alias

string

是

批次内标识 / 主键

paramMap

object

否

启动参数

comment

string

否

备注

filePath

string

否

扩展；可为 null

响应 — HTTP 200，Body 为数组，元素类型 LaunchReturnForBatchVO

字段名

类型

说明

alias

string

对应请求中的别名

success

boolean

本条是否启动成功

procInstId

string

成功时的流程实例 ID

businessKey

string

业务键

paramMap

object

参数快照

errorMsg

string

失败原因

请求示例

Copy
{
  "elementDetail": { "elementName": "single_approve", "folderId": "DIR1f57bbb34296", "path": null },
  "multipleParams": [
    {
      "alias": "0",
      "comment": "批量示例-第 1 条",
      "filePath": null,
      "paramMap": { "input1_str": "20250904", "input2": "1778214583.986806", "input3_int": 1 }
    },
    {
      "alias": "1",
      "comment": "批量示例-第 2 条",
      "filePath": null,
      "paramMap": { "input1_str": "20250904", "input2": "1778214583.98681", "input3_int": 2 }
    }
  ]
}

响应示例（经网关包层；单条失败时仍可能 status: true，看本条 success）

Copy
{
  "status": true,
  "data": [
    {
      "alias": "doc-sample-0",
      "success": false,
      "procInstId": null,
      "businessKey": null,
      "paramMap": {
        "input1_str": "20250904",
        "input2": "1778214583.986806",
        "input3_int": 1
      },
      "errorMsg": "已存在业务键相同的活跃流程，不允许重复发起"
    }
  ],
  "code": 0,
  "message": null
}

流程实例

按业务键查询流程实例

根据业务键（精确或模糊）反查流程实例列表。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/api/process-instance/get-by-business-key

Header 参数

参数名

类型

必填

说明

space

string

是

空间 ID

app

string

是

应用 ID

user

string

否

用户 ID

language

string

否

语言，如 zh-cn

Body — BusinessKeyQueryDTO

字段名

类型

必填

说明

businessKey

object

是

结构见下表「业务键」

elementDetail

object

否

元素定位，结构见下表「元素定位」

version

string

否

流程版本号，V 开头；不传通常取最新发布版

业务键（businessKey）

字段名

类型

必填

说明

compareType

string

是

EQUAL 精确匹配 / LIKE 模糊匹配

key

string

是

业务键取值

元素定位（ElementDetailDTO，嵌套于 elementDetail）

字段名

类型

必填

说明

elementName

string

是

工作流元素编码

folderId

string

否

目录 ID，与 path 二选一

path

string

否

元素路径，与 folderId 二选一

响应 — HTTP 200。经网关时 data 为 ProcessInstanceVO 数组；无匹配时多为空数组 []。下表为数组元素字段（与「按启动参数查询流程实例」一致）。

字段名

类型

说明

procInstId

string

流程实例 ID

procDisplayName

string

流程实例展示名称

businessKey

string

业务键

processId

string

工作流元素 ID

procElementName

string

工作流元素编码

procElementPath

string

工作流元素路径

procElementFolderId

string

工作流元素 folderId

procDefId

string

工作流版本定义 ID

version

string

版本号

startUserId

string

发起人 ID

startUser

object

发起人详情（UserDetailVO）

startTime

string

开始时间

endTime

string

结束时间

state

string

流程状态

dueTime

string

过期时间

expiredStatus

string

过期状态

请求示例（与 DeepFlow / SDK 常见调用一致：elementDetail 限定元素范围，path 可显式为 null）

Copy
{
  "businessKey": { "compareType": "EQUAL", "key": "1|1778214583.7383173" },
  "elementDetail": {
    "elementName": "single_approve",
    "folderId": "DIR1f57bbb34296",
    "path": null
  },
  "version": null
}

响应示例（无匹配；经网关包层）

Copy
{
  "status": true,
  "data": [],
  "code": 0,
  "message": null
}

响应示例（命中一条；经网关包层，用户信息已匿名化） — 单条元素字段与「按启动参数查询流程实例」响应示例中的 data[0] 形态一致，此处从略，可直接参照该节。

按启动参数查询流程实例

用与启动时一致的参数组合反查流程实例列表。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/api/process-instance/get-by-launch-params

Header 参数

参数名

类型

必填

说明

space

string

否

空间 ID

app

string

否

应用 ID

user

string

否

用户 ID

language

string

否

语言

Body — LaunchParamsDTO

字段名

类型

必填

说明

elementDetail

object

是

元素定位，结构见下表「元素定位」

paramMap

object

是

启动参数；值不可为空，且不可为数组、对象（依 OpenAPI 约束）

version

string

否

版本号，V 开头；不传通常取最新

元素定位（ElementDetailDTO）

字段名

类型

必填

说明

elementName

string

是

工作流元素编码

folderId

string

否

目录 ID，与 path 二选一

path

string

否

元素路径，与 folderId 二选一

响应 — HTTP 200，Body 为数组，元素类型 ProcessInstanceVO

字段名

类型

说明

procInstId

string

流程实例 ID

procDisplayName

string

流程实例展示名称

businessKey

string

业务键

processId

string

工作流元素 ID

procElementName

string

工作流元素编码

procElementPath

string

工作流元素路径

procElementFolderId

string

工作流元素 folderId

procDefId

string

工作流版本定义 ID

version

string

版本号

startUserId

string

发起人 ID

startUser

object

发起人详情（UserDetailVO）

startTime

string

开始时间

endTime

string

结束时间

state

string

流程状态

dueTime

string

过期时间

expiredStatus

string

过期状态

请求示例

Copy
{
  "elementDetail": { "elementName": "single_approve", "folderId": "DIR1f57bbb34296", "path": null },
  "paramMap": { "input1_str": "20250904", "input3_int": 1, "input2": "1778214583.986806" },
  "version": null
}

响应示例（经网关包层；data 为 ProcessInstanceVO 数组，用户信息已匿名化）

Copy
{
  "status": true,
  "data": [
    {
      "procInstId": "00000000-0000-0000-0000-0000000000a1",
      "procDisplayName": "工作流：20250904-1",
      "businessKey": "20250904|1|1778214583.986806",
      "processId": "p-demo-process-id",
      "procElementName": "single_approve",
      "procElementPath": "\\function\\",
      "procElementFolderId": "DIR1f57bbb34296",
      "procDefId": "00000000-0000-0000-0000-0000000000b2",
      "version": "V19.0",
      "startUserId": "00000000-0000-0000-0000-000000000001",
      "startUser": {
        "userId": "00000000-0000-0000-0000-000000000001",
        "userName": "demo_user",
        "nickName": "示例用户",
        "status": "1"
      },
      "startTime": "Fri May 08 12:29:44 GMT+08:00 2026",
      "endTime": null,
      "state": "InProgress",
      "dueTime": null,
      "expiredStatus": "NORMAL"
    }
  ],
  "code": 0,
  "message": null
}

按流程实例 ID 查询详情

根据 procInstId 查询单条流程实例（含变量等）。

请求概要

项目

值

HTTP Method

GET

Path（相对）

/process/api/process-instance/id

Header 参数

参数名

类型

必填

说明

space

string

是

空间 ID

app

string

是

应用 ID

user

string

是

用户 ID

cookie

string

是

登录会话 Cookie

Query 参数

参数名

类型

必填

说明

procInstId

string

是

流程实例 ID

响应 — HTTP 200，Body 类型 ProcInstReturnVO

字段名

类型

说明

procInstId

string

流程实例 ID

procInstName

string

流程实例名称

businessKey

string

业务键

elementDetail

object

工作流元素信息

procDefId

string

工作流唯一标识

version

string

版本号

versionName

string

版本名称

startTime

string

开始时间

endTime

string

结束时间

startUserId

string

发起人 ID

state

string

流程状态

stateDesc

object

流程状态描述

variables

object

流程变量

任务实例

按业务键查询任务实例

根据业务键反查任务实例列表（/process/api 前缀）。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/api/task-instance/get-by-business-key

Header 参数

参数名

类型

必填

说明

space

string

否

空间 ID

app

string

否

应用 ID

user

string

否

用户 ID

language

string

否

语言

Body — BusinessKeyQueryDTO

字段名

类型

必填

说明

businessKey

object

是

结构见下表「业务键」

elementDetail

object

否

元素定位，结构见下表「元素定位」

version

string

否

版本号，V 开头

业务键

字段名

类型

必填

说明

compareType

string

是

EQUAL / LIKE

key

string

是

业务键

元素定位（ElementDetailDTO）

字段名

类型

必填

说明

elementName

string

是

工作流元素编码

folderId

string

否

目录 ID，与 path 二选一

path

string

否

元素路径，与 folderId 二选一

响应 — HTTP 200。经网关时 data 为 TaskInstanceVO 数组；无匹配时多为空数组 []。下表为数组元素字段。

字段名

类型

说明

taskId

string

任务实例 ID

taskCode

string

任务 CODE

taskName

string

任务名称

taskDisplayName

string

任务展示名称

owner

string

所属人

assignee

string

处理人

assigneeType

string

处理人类型

priority

string

优先级

procInstId

string

流程实例 ID

procDisplayName

string

流程实例展示名称

businessKey

string

业务键

processId

string

工作流元素 ID

procElementName

string

工作流元素编码

procElementPath

string

工作流元素路径

procElementFolderId

string

folderId

procDefId

string

流程定义 ID

version

string

版本号

startTime

string

开始时间

endTime

string

结束时间

state

string

状态

请求示例

Copy
{
  "businessKey": { "compareType": "EQUAL", "key": "20250904|1|1778214583.986806" },
  "elementDetail": {
    "elementName": "single_approve",
    "folderId": "DIR1f57bbb34296",
    "path": null
  },
  "version": null
}

响应示例（经网关包层；data 中单条任务已简化）

Copy
{
  "status": true,
  "data": [
    {
      "taskId": "00000000-0000-0000-0000-0000000000e1",
      "taskName": "审批",
      "procInstId": "00000000-0000-0000-0000-0000000000e2",
      "businessKey": "20250904|1|1778214583.986806",
      "procElementName": "single_approve",
      "state": "InProgress"
    }
  ],
  "code": 0,
  "message": null
}

按启动参数查询任务实例

用与启动时一致的参数组合反查任务实例列表。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/api/task-instance/get-by-launch-params

Header 参数

参数名

类型

必填

说明

space

string

否

空间 ID

app

string

否

应用 ID

user

string

否

用户 ID

language

string

否

语言

Body — LaunchParamsDTO

字段名

类型

必填

说明

elementDetail

object

是

元素定位，结构见下表「元素定位」

paramMap

object

是

启动参数

version

string

否

版本号，V 开头

元素定位（ElementDetailDTO）

字段名

类型

必填

说明

elementName

string

是

工作流元素编码

folderId

string

否

目录 ID，与 path 二选一

path

string

否

元素路径，与 folderId 二选一

响应 — HTTP 200，Body 为数组，元素类型 TaskInstanceVO

字段名

类型

说明

taskId

string

任务实例 ID

taskCode

string

任务 CODE

taskName

string

任务名称

taskDisplayName

string

任务展示名称

owner

string

所属人

assignee

string

处理人

assigneeType

string

处理人类型

priority

string

优先级

procInstId

string

流程实例 ID

procDisplayName

string

流程实例展示名称

businessKey

string

业务键

processId

string

工作流元素 ID

procElementName

string

工作流元素编码

procElementPath

string

工作流元素路径

procElementFolderId

string

folderId

procDefId

string

流程定义 ID

version

string

版本号

startTime

string

开始时间

endTime

string

结束时间

state

string

状态

按任务实例 ID 查询详情

根据 taskId 查询单条任务详情。

请求概要

项目

值

HTTP Method

GET

Path（相对）

/process/api/task-instance/id

Header 参数

参数名

类型

必填

说明

space

string

是

空间 ID

app

string

是

应用 ID

user

string

是

用户 ID

cookie

string

是

登录会话 Cookie

Query 参数

参数名

类型

必填

说明

taskId

string

是

任务实例 ID

响应 — HTTP 200，Body 类型 TaskInstReturnSingleVO

字段名

类型

说明

taskId

string

任务实例 ID

name

string

任务实例名称

owner

string

所属人

assignee

string

执行人

assigneeType

string

执行人类型

candidate

object

候选人

priority

string

优先级

procInstId

string

流程实例 ID

procInstName

string

流程实例名称

businessKey

string

业务键

elementDetail

object

元素信息

procDefId

string

流程定义 ID

startTime

string

开始时间

endTime

string

结束时间

dueDate

string

截止时间

state

string

任务状态

proiorityDesc

object

优先级描述

stateDesc

object

状态描述

任务中心

待认领任务（分页）

任务池中尚未认领的任务分页列表。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/task/claim/list/page

Header 参数

参数名

类型

必填

说明

space

string

否

空间 ID

app

string

否

应用 ID

user

string

否

用户 ID

language

string

否

语言

Body — UserTaskQueryDTO

字段名

类型

必填

说明

status

string

是

任务状态

mergeClaimTaskPage

boolean

否

是否合并待认领任务页

search

string

否

搜索关键字

filters

array

否

筛选条件

nodeFilters

array

否

相同节点筛选条件

pageNo

integer

否

页码

pageSize

integer

否

每页条数

响应 — HTTP 200，Body 类型 PageInfoUserTaskVO

字段名

类型

说明

lists

array

当前页任务列表，元素 UserTaskVO

totalCount

integer

总条数

pageSize

integer

每页大小

currentPage

integer

当前页

start

integer

分页起始

totalPage

integer

总页数

UserTaskVO（lists 单项主要字段）

字段名

类型

说明

taskId

string

任务 ID

taskName

string

任务名称

processInstanceId

string

流程实例 ID

taskStatus

string

任务状态

claimStatus

string

认领状态

definitionName

string

工作流名称

elementName

string

元素编码

folderId

string

文件夹 ID

path

string

路径

nodeCode / nodeName

string

节点编码 / 名称

startTime / endTime / dueTime

string

时间

priority

string

优先级 LOW/MID/HIGH

executor

object

执行人

enableQuickComplete

boolean

是否可快速处理

enableAllowedComment

boolean

是否允许备注

version

string

任务版本号

响应示例（PageInfoUserTaskVO；脱敏） — 经网关时多在根级 data 内；以下为负载本体。lists 单项除上表外，常见还有 startUser（发起人）、processDefinitionId、taskDefinitionKey、candidateNames、expiredStatus、userPage / userPageUrl / userPageStatus（跳转页与参数）等。

Copy
{
  "currentPage": 1,
  "pageSize": 20,
  "lists": [
    {
      "taskId": "00000000-0000-0000-0000-0000000000e1",
      "taskName": "单人任务2-示例后缀",
      "startUser": {
        "userId": "00000000-0000-0000-0000-000000000001",
        "userName": "demo_user",
        "nickName": "示例用户",
        "status": "1"
      },
      "startTime": "2025-11-19 16:27:17",
      "priority": "MID",
      "dueTime": null,
      "endTime": null,
      "processInstanceId": "00000000-0000-0000-0000-0000000000e2",
      "processDefinitionId": "00000000-0000-0000-0000-0000000000e3",
      "taskDefinitionKey": "p-demo-task-def-key",
      "definitionName": "如何实现业务数据必填校验-示例",
      "expiredStatus": "NORMAL",
      "elementName": "如何实现业务数据必填校验",
      "folderId": "DIR000000000001",
      "path": "\\DEMO_BP_verify_02\\",
      "nodeCode": "single_user_task1",
      "nodeName": "单人任务2（校验排在完成时监听）",
      "processId": "p-demo-node-id",
      "taskStatus": "InProgress",
      "candidateNames": "示例用户, other_user",
      "enableQuickComplete": true,
      "quickCompleteButtonName": "快速处理",
      "enableAllowedComment": false,
      "userPage": {
        "elementDetail": {
          "elementName": "DEMO_BP_verify_02_taskhandle",
          "folderId": "DIR000000000001",
          "path": "\\DEMO_BP_verify_02\\",
          "elementType": "UX",
          "serverName": "ux-server1-0"
        },
        "params": [
          { "key": "proc_id", "value": "\"00000000-0000-0000-0000-0000000000e2\"" },
          { "key": "task_id", "value": "\"00000000-0000-0000-0000-0000000000e1\"" },
          { "key": "business_key", "value": "\"demoBizKey\"" }
        ]
      },
      "userPageStatus": "ENABLE",
      "userPageButtonName": "查看",
      "userPageUrl": "https://{host}/element-ux/1-0-0/?elementName=DEMO_BP_verify_02_taskhandle&proc_id=…",
      "version": "V8.0"
    }
  ],
  "totalCount": 1,
  "start": 0,
  "totalPage": 1
}

我的待办任务（分页）

当前登录用户的待办任务分页列表。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/task/myTask/list/page

Header 参数

参数名

类型

必填

说明

space

string

否

空间 ID

app

string

否

应用 ID

user

string

否

用户 ID

language

string

否

语言

Body — UserTaskQueryDTO

字段名

类型

必填

说明

status

string

是

任务状态

mergeClaimTaskPage

boolean

否

是否合并待认领任务页

search

string

否

搜索关键字

filters

array

否

筛选条件

nodeFilters

array

否

相同节点筛选条件

pageNo

integer

否

页码

pageSize

integer

否

每页条数

响应 — HTTP 200，Body 类型 TodoPageInfoUserTaskVO

字段名

类型

说明

lists

array

当前页任务列表，元素 UserTaskVO

totalCount

integer

总条数

pageSize

integer

每页大小

currentPage

integer

当前页

inProgressCount

integer

进行中任务数

completedCount

integer

已完成任务数

terminatedCount

integer

已终止任务数

totalTaskCount

integer

全部任务数

start

integer

分页起始

totalPage

integer

总页数

UserTaskVO（lists 单项主要字段）

字段名

类型

说明

taskId

string

任务 ID

taskName

string

任务名称

processInstanceId

string

流程实例 ID

taskStatus

string

任务状态

claimStatus

string

认领状态

definitionName

string

工作流名称

elementName

string

元素编码

folderId

string

文件夹 ID

path

string

路径

nodeCode

string

节点编码

nodeName

string

任务节点

startTime

string

开始时间

endTime

string

结束时间

dueTime

string

截止/到期时间

priority

string

优先级 LOW/MID/HIGH

priorityDes

object

优先级描述

executor

object

执行人

expiredStatus

string

过期状态

expiredStatusDesc

object

过期状态描述

enableQuickComplete

boolean

是否可快速处理

enableAllowedComment

boolean

是否允许备注

userPageUrl

string

查看任务跳转路径

version

string

任务版本号

请求示例

Copy
{
  "pageNo": 1,
  "pageSize": 20,
  "mergeClaimTaskPage": false,
  "status": "InProgress"
}

响应示例（经网关包层；lists 已简化）

Copy
{
  "status": true,
  "data": {
    "lists": [
      {
        "taskId": "00000000-0000-0000-0000-0000000000e1",
        "taskName": "示例审批",
        "processInstanceId": "00000000-0000-0000-0000-0000000000e2",
        "taskStatus": "InProgress",
        "definitionName": "示例工作流",
        "elementName": "single_approve",
        "nodeName": "审批"
      }
    ],
    "totalCount": 1,
    "pageSize": 20,
    "currentPage": 1,
    "inProgressCount": 1,
    "completedCount": 0,
    "terminatedCount": 0,
    "totalTaskCount": 1,
    "start": 0,
    "totalPage": 1
  },
  "code": 0,
  "message": null
}

查询任务结果选项（Outcomes）

完成任务前获取可选结果编码及按钮 ID（新节点模型下 actionId）。

请求概要

项目

值

HTTP Method

GET

Path（相对）

/process/task/outcomes

Header 参数

参数名

类型

必填

说明

space

string

否

空间 ID

app

string

否

应用 ID

user

string

否

用户 ID

language

string

否

语言

Query 参数

参数名

类型

必填

说明

taskId

string

是

任务实例 ID

响应 — HTTP 200，Body 为数组，元素类型 outcome

字段名

类型

说明

id

string

按钮 / 结果 ID，可作完成任务时的 actionId

code

string

结果编码，对应完成任务时的 outcome

name

object

多语言名称

响应示例

Copy
[
  { "id": "btn-approve-uuid", "code": "approve", "name": { "zh-cn": "同意", "en": "Approve" } }
]

完成任务

提交任务处理结果（结果、备注、附件、扩展参数）。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/task/express-complete

Header 参数

参数名

类型

必填

说明

space

string

否

空间 ID

app

string

否

应用 ID

user

string

否

用户 ID

language

string

否

语言

Body — 任务完成实体

字段名

类型

必填

说明

taskId

string

是

任务实例 ID

outcome

string

是

结果选项编码

actionId

string

否

按钮 ID；新节点场景常与 Outcomes 的 id 一致

comment

string

否

备注

filePath

string

否

扩展占位，无附件时多为 null

attachments

array

否

附件列表，AttachmentDetail

extraResParams

array

否

扩展参数，元素见下表

extraResParams 单项 — 完成任务额外参数

字段名

类型

必填

说明

name

string

是

参数名

value

any

否

参数值

响应 — HTTP 200。经网关时 data 为 boolean，表示是否提交成功；失败时见根级 status/message/code。

请求示例

Copy
{
  "taskId": "00000000-0000-0000-0000-0000000000e1",
  "outcome": "approve",
  "actionId": "taskHandleBtn_7de1e38",
  "comment": "数据流完成",
  "filePath": null,
  "attachments": [],
  "extraResParams": [
    { "name": "test1", "value": "run-correlation-id" },
    { "name": "user", "value": "00000000-0000-0000-0000-000000000001" }
  ]
}

响应示例（经网关包层）

Copy
{
  "status": true,
  "data": true,
  "code": 0,
  "message": null
}

流程消息

发送流程消息

驱动「捕获消息」类节点：向指定流程实例或全体订阅者投递消息体。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/api/send-message

Header 参数

参数名

类型

必填

说明

space

string

是

空间 ID

app

string

是

应用 ID

user

string

是

用户 ID

cookie

string

是

登录会话 Cookie

Body — 发送消息参数

字段名

类型

必填

说明

messageInfo

object

是

见下表「消息」

scope

object

是

见下表「发送消息范围」

消息（messageInfo）

字段名

类型

必填

说明

messageCode

string

是

消息编码，须与画布上该工作流的消息事件配置一致

messageBody

object

是

负载；预置字段可不填

relateProcess

object

是

关联工作流元素，结构见下表「元素定位」

元素定位（relateProcess / ElementDetailDTO）

字段名

类型

必填

说明

elementName

string

是

工作流元素编码

folderId

string

否

目录 ID，与 path 二选一

path

string

否

元素路径，与 folderId 二选一

发送消息范围（scope）

字段名

类型

必填

说明

type

string

是

ALL_SUBSCRIBER 广播 / PROCESS_INSTANCE 指定实例

processInstanceIds

array[string]

条件

type 为 PROCESS_INSTANCE 时必填

请求示例（指定实例）

Copy
{
  "messageInfo": {
    "messageCode": "message2",
    "messageBody": { "is_active": true },
    "relateProcess": { "elementName": "test_task", "path": "\\" }
  },
  "scope": {
    "type": "PROCESS_INSTANCE",
    "processInstanceIds": ["37df1f37-ed71-11ed-88c1-c65a503b41ed"]
  }
}

流程监控

流程监控（分页）

前台「流程监控」列表：按状态、关键字、筛选器分页查询流程实例。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/instance/monitor/page

Header 参数

参数名

类型

必填

说明

space

string

是

空间 ID

app

string

是

应用 ID

user

string

是

用户 ID

language

string

否

语言

Body — 流程实例查询dto

字段名

类型

必填

说明

status

string

是

流程状态

search

string

否

搜索关键字

filters

array

否

筛选条件，元素 QueryFilterDTO

pageNo

integer

否

页码

pageSize

integer

否

每页条数

taskNameFilter

object

否

当前节点筛选，QueryFilterDTO

assigneeFilter

object

否

当前负责人筛选，QueryFilterDTO

elementId

string

否

元素 ID

orderBy

array

否

排序，元素 OrderByDTO

QueryFilterDTO（单条筛选）

字段名

类型

说明

key

string

筛选字段

filterType

string

操作符

fieldType

string

字段/变量标识

value

string

值

OrderByDTO（单条排序）

字段名

类型

说明

field

string

排序字段

sortOrder

string

排序顺序

响应 — HTTP 200，Body 类型 UnderwayPageInfo流程实例返回dto

字段名

类型

说明

lists

array

当前页数据列表

totalCount

integer

总条数

pageSize

integer

每页大小

currentPage

integer

当前页

inProgressCount

integer

进行中流程数（统计）

completedCount

integer

已完成流程数

terminatedCount

integer

已终止流程数

pausedCount

integer

暂停流程数

totalProcessCount

integer

全部流程数

start

integer

分页起始

totalPage

integer

总页数

我发起的流程（分页）

当前用户作为发起人看到的流程实例分页列表。

请求概要

项目

值

HTTP Method

POST

Path（相对）

/process/instance/started-by-me/page

Header 参数

参数名

类型

必填

说明

space

string

是

空间 ID

app

string

是

应用 ID

cookie

string

是

登录会话 Cookie

user

string

否

用户 ID

language

string

否

语言

Body — 流程实例查询dto

字段名

类型

必填

说明

status

string

是

流程状态

search

string

否

搜索关键字

filters

array

否

筛选条件，QueryFilterDTO

pageNo

integer

否

页码

pageSize

integer

否

每页条数

taskNameFilter

object

否

当前节点筛选

assigneeFilter

object

否

当前负责人筛选

elementId

string

否

元素 ID

orderBy

array

否

排序，OrderByDTO

QueryFilterDTO（单条筛选）

字段名

类型

说明

key

string

筛选字段

filterType

string

操作符

fieldType

string

字段/变量标识

value

string

值

OrderByDTO（单条排序）

字段名

类型

说明

field

string

排序字段

sortOrder

string

排序顺序

响应 — HTTP 200，Body 类型 UnderwayPageInfo流程实例返回dto

字段名

类型

说明

lists

array

当前页数据列表

totalCount

integer

总条数

pageSize

integer

每页大小

currentPage

integer

当前页

inProgressCount

integer

进行中流程数

completedCount

integer

已完成流程数

terminatedCount

integer

已终止流程数

pausedCount

integer

暂停流程数

totalProcessCount

integer

全部流程数

start

integer

分页起始

totalPage

integer

总页数

参考

  • 更多路径（设计发布、转办、/process/layer/*、批量完成等）：OpenAPI。

  • Python SDK：deepfos.element.workflow — 说明。

上一篇：数据表
下一篇：数据流
本页目录

回到顶部

咨询热线

400-821-9199

我们使用 ChatGPT，基于文档中心的内容以及对话上下文回答您的问题。

ctrl+Enter to send

© 2022 先胜云. All Rights Reserved.