文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 流程引擎/ 流程运行/ 启动流程 - startProcessInstance
更新时间：2025-11-07 GMT+08:00
查看PDF
分享

启动流程 - startProcessInstance

功能介绍

发起流程。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /console/servicetask/api/localMethod/start_process/startProcessInstance

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

通过调用IAM服务获取用户Token接口获取（即响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Application-Id

是

String

参数解释：

应用ID。

您可以在应用设计态的“应用中心 > 应用发布”页面获取，详情请参见应用发布。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Tenant-Id

是

String

参数解释：

数据建模引擎运行态租户ID。

您可以从访问流程引擎编排服务的浏览器地址栏中获取。

流程编排服务地址：http://{承载流程编排服务的服务器域名或IP地址}:{流程编排服务的端口号}/{流程编排服务文根}/index.html#/processApplicationForm?tenantId={数据建模引擎运行态租户ID}&applicationId={应用ID}

例如tenantId=-1，表示数据建模引擎运行态默认租户“basicTenant”的租户ID为-1。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-User-Id

是

String

参数解释：

请求当前接口时上下文中的用户ID，即OrgID的用户ID。仅基础版数据建模引擎-流程引擎需要配置此参数。

通过调用OrgID服务的获取用户信息接口获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

否

Array of DefinitionArrayParam objects

参数解释：

启动流程入参集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 DefinitionArrayParam

参数

是否必选

参数类型

描述

blockType

是

String

参数解释：

区块类型：业务组件serverKey。

约束限制：

不涉及。

取值范围：

  • attachment：附件组件。

  • participant：设置参与者。

  • start_process：启动流程。

  • save_process_draft：保存草稿。

默认取值：

不涉及。

nodeId

是

String

参数解释：

区块ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

blockId

是

String

参数解释：

节点ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

data

否

Array of strings

参数解释：

携带数据。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

code

Integer

参数解释：

接口返回码。

取值范围：

不涉及。

默认取值：

不涉及。

data

data object

参数解释：

接口响应数据。

取值范围：

不涉及。

默认取值：

不涉及。

orderID

String

参数解释：

请求跟踪流水号。

取值范围：

不涉及。

默认取值：

不涉及。
表5 data

参数

参数类型

描述

processInstanceId

String

参数解释：

流程实例ID。

取值范围：

不涉及。

默认取值：

不涉及。

businessKey

String

参数解释：

申请单key。

取值范围：

不涉及。

默认取值：

不涉及。

taskList

Array of taskList objects

参数解释：

任务列表。

取值范围：

不涉及。

默认取值：

不涉及。

processDefinitionName

String

参数解释：

流程定义英文名称。

取值范围：

不涉及。

默认取值：

不涉及。

version

Integer

参数解释：

流程模板定义版本。

取值范围：

不涉及。

默认取值：

不涉及。
表6 taskList

参数

参数类型

描述

processDefinitionId

String

参数解释：

流程模板ID。

取值范围：

不涉及。

默认取值：

不涉及。

processInstanceId

String

参数解释：

流程实例ID。

取值范围：

不涉及。

默认取值：

不涉及。

suspensionState

Integer

参数解释：

挂起状态。

取值范围：

不涉及。

默认取值：

不涉及。

taskDefinitionKey

String

参数解释：

任务节点Key。

取值范围：

不涉及。

默认取值：

不涉及。

businessKey

String

参数解释：

业务单据ID。

取值范围：

不涉及。

默认取值：

不涉及。

name

String

参数解释：

任务名称。

取值范围：

不涉及。

默认取值：

不涉及。

assignee

String

参数解释：

审核人。

取值范围：

不涉及。

默认取值：

不涉及。

id

String

参数解释：

任务ID。

取值范围：

不涉及。

默认取值：

不涉及。

priority

Integer

参数解释：

优先级。

取值范围：

不涉及。

默认取值：

不涉及。

transferSign

Boolean

参数解释：

是否在流程管理编辑里面配置了转审组件。

取值范围：

  • true：是。

  • false：否。

默认取值：

不涉及。

请求示例

https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/console/servicetask/api/localMethod/start_process/startProcessInstance

[
    {
        "blockType": "start_process",
        "nodeId": "",
        "blockId": "",
        "data": [
            {
                "processTemplateName": "WXR2024031201",
                "processTemplateVersion": "5",
                "businessKey": "P10000548"
…]

响应示例

状态码：200

OK

{
  "code" : 0,
  "data" : {
    "processInstanceId" : "2b263825-e206-11ee-b9f9-7804e3968f51",
    "businessKey" : "P10000548",
    "taskList" : [ {
      "processDefinitionId" : "WXR2024031201:5:32ff36dd48024b9b8da61e8b44dd27df",
      "processInstanceId" : "2b263825-e206-11ee-b9f9-7804e3968f51",
      "suspensionState" : 1,
      "taskDefinitionKey" : "Activity_0g0ayay",
      "transferSign" : false,
      "businessKey" : "P10000548",
      "name" : "用户任务",
      "assignee" : "u.hid_fje4j2nvnue3xwp",
      "id" : "2b542501-e206-11ee-b9f9-7804e3968f51",
      "priority" : 50
    } ],
    "processDefinitionName" : "WXR2024031201",
    "version" : 5
  },
  "orderID" : "d05ef61428014dd3804038ae6a9a9aea"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 流程运行

相关文档