更新时间:2025-06-23 GMT+08:00
分享

获取流程变量

功能介绍

通过流程实例ID获取流程变量。

URI

GET /services/workflow/processInstance/instance/getVariables

表1 Query参数

参数

是否必选

参数类型

描述

processInstanceId

String

参数解释:

流程实例ID,可通过我的任务、我发起的流程等接口获取。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

pageSize

String

参数解释:

分页大小。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

curPage

String

参数解释:

当前页。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求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服务的获取用户信息接口获取。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

code

String

参数解释:

返回状态。

取值范围:

  • 200:成功。

  • 500:失败。

默认取值:

不涉及。

message

String

参数解释:

流程实例ID。

取值范围:

不涉及。

默认取值:

不涉及。

result

Array of ProcessInstanceVariablesVO objects

参数解释:

返回响应数据列表。

取值范围:

不涉及。

默认取值:

不涉及。

pageVO

AdaptPageVO object

参数解释:

返回单个响应数据。

取值范围:

不涉及。

默认取值:

不涉及。

i18n

Array of I18nDisplay objects

参数解释:

返回响应的国际化信息。

取值范围:

不涉及。

默认取值:

不涉及。

orderId

String

参数解释:

全局日志追踪ID。

取值范围:

不涉及。

默认取值:

不涉及。

表4 ProcessInstanceVariablesVO

参数

参数类型

描述

id

String

参数解释:

流程变量ID。

取值范围:

不涉及。

默认取值:

不涉及。

processDefinitionId

String

参数解释:

该流程的流程模板key+版本+流程实例ID。

取值范围:

不涉及。

默认取值:

不涉及。

processDefinitionKey

String

参数解释:

流程模板ID。

取值范围:

不涉及。

默认取值:

不涉及。

rootProcessInstanceId

String

参数解释:

历史事件触发时的父流程ID。

取值范围:

不涉及。

默认取值:

不涉及。

processInstanceId

String

参数解释:

流程实例ID。

取值范围:

不涉及。

默认取值:

不涉及。

taskId

String

参数解释:

流程任务ID。

取值范围:

不涉及。

默认取值:

不涉及。

tenantId

String

参数解释:

租户ID。

取值范围:

不涉及。

默认取值:

不涉及。

executionId

String

参数解释:

流程执行段ID。

取值范围:

不涉及。

默认取值:

不涉及。

activityInstanceId

String

参数解释:

活动实例ID。

取值范围:

不涉及。

默认取值:

不涉及。

name

String

参数解释:

流程变量名。

取值范围:

不涉及。

默认取值:

不涉及。

caseDefinitionKey

String

参数解释:

流程变量ID。

取值范围:

不涉及。

默认取值:

不涉及。

caseDefinitionId

String

参数解释:

案例定义ID。

取值范围:

不涉及。

默认取值:

不涉及。

caseInstanceId

String

参数解释:

案例实例ID。

取值范围:

不涉及。

默认取值:

不涉及。

caseExecutionId

String

参数解释:

案例执行ID。

取值范围:

不涉及。

默认取值:

不涉及。

revision

Integer

参数解释:

流程变量修改版本。

取值范围:

不涉及。

默认取值:

不涉及。

createTime

DateTime

参数解释:

流程变量创建时间。

取值范围:

不涉及。

默认取值:

不涉及。

value

String

参数解释:

流程变量值。

取值范围:

不涉及。

默认取值:

不涉及。

textValue2

String

参数解释:

流程变量文本值。

取值范围:

不涉及。

默认取值:

不涉及。

type

String

参数解释:

流程变量类型。

取值范围:

不涉及。

默认取值:

不涉及。

state

String

参数解释:

流程变量状态。

取值范围:

不涉及。

默认取值:

不涉及。

taskDefinitionKey

String

参数解释:

模板中节点(任务)的编号。

取值范围:

不涉及。

默认取值:

不涉及。

taskDefinitionName

String

参数解释:

流程变量ID。

取值范围:

不涉及。

默认取值:

不涉及。

taskDefinitionType

String

参数解释:

模板中节点(任务)的类型。

取值范围:

不涉及。

默认取值:

不涉及。

表5 AdaptPageVO

参数

参数类型

描述

totalRows

Integer

参数解释:

数据总数。

取值范围:

不涉及。

默认取值:

不涉及。

curPage

Integer

参数解释:

当前页。

取值范围:

不涉及。

默认取值:

不涉及。

pageSize

Integer

参数解释:

页大小。

取值范围:

不涉及。

默认取值:

不涉及。

totalPages

Integer

参数解释:

总页数。

取值范围:

不涉及。

默认取值:

不涉及。

startIndex

Integer

参数解释:

开始下标。

取值范围:

不涉及。

默认取值:

不涉及。

endIndex

Integer

参数解释:

结束下标。

取值范围:

不涉及。

默认取值:

不涉及。

offset

Integer

参数解释:

偏移量。

取值范围:

不涉及。

默认取值:

不涉及。

i18n

String

参数解释:

国际化代码。

取值范围:

不涉及。

默认取值:

不涉及。

表6 I18nDisplay

参数

参数类型

描述

key

String

参数解释:

国际化数据key值。

取值范围:

不涉及。

默认取值:

不涉及。

value

String

参数解释:

国际化数据key对应的value值。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

响应示例

状态码:200

OK

{
  "code" : 200,
  "message" : "success",
  "pageVO" : {
    "totalRows" : 8,
    "curPage" : 1,
    "pageSize" : 100,
    "startIndex" : 1,
    "endIndex" : 100,
    "offset" : 0,
    "totalPages" : 1
  },
  "result" : [ {
    "id" : "154aa1ba-ad56-11ef-94c2-fa163e3e9614",
    "processDefinitionId" : "Process_xiejia_1126_2:1:a60b112ee2304d84a5432b94e86d81ec",
    "processDefinitionKey" : "Process_xiejia_1126_2",
    "rootProcessInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "processInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "taskId" : null,
    "tenantId" : 10000243,
    "executionId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "activityInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "name" : "Activity_16kgz9u",
    "caseDefinitionKey" : null,
    "caseDefinitionId" : null,
    "caseInstanceId" : null,
    "caseExecutionId" : null,
    "revision" : 0,
    "createTime" : "2024-11-28T06:57:50.778+0000",
    "value" : "93172bbfd0f64437956d4c9de9345386",
    "textValue2" : null,
    "type" : "string",
    "state" : "CREATED",
    "taskDefinitionKey" : "Global",
    "taskDefinitionName" : "Global",
    "taskDefinitionType" : "processInstance"
  }, {
    "id" : "154aa1bb-ad56-11ef-94c2-fa163e3e9614",
    "processDefinitionId" : "Process_xiejia_1126_2:1:a60b112ee2304d84a5432b94e86d81ec",
    "processDefinitionKey" : "Process_xiejia_1126_2",
    "rootProcessInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "processInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "taskId" : null,
    "tenantId" : 10000243,
    "executionId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "activityInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "name" : "applicant",
    "caseDefinitionKey" : null,
    "caseDefinitionId" : null,
    "caseInstanceId" : null,
    "caseExecutionId" : null,
    "revision" : 0,
    "createTime" : "2024-11-28T06:57:50.778+0000",
    "value" : "XDM_Developer",
    "textValue2" : null,
    "type" : "string",
    "state" : "CREATED",
    "taskDefinitionKey" : "Global",
    "taskDefinitionName" : "Global",
    "taskDefinitionType" : "processInstance"
  }, {
    "id" : "154aa1b9-ad56-11ef-94c2-fa163e3e9614",
    "processDefinitionId" : "Process_xiejia_1126_2:1:a60b112ee2304d84a5432b94e86d81ec",
    "processDefinitionKey" : "Process_xiejia_1126_2",
    "rootProcessInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "processInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "taskId" : null,
    "tenantId" : 10000243,
    "executionId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "activityInstanceId" : "154a5392-ad56-11ef-94c2-fa163e3e9614",
    "name" : "_mail_cc",
    "caseDefinitionKey" : null,
    "caseDefinitionId" : null,
    "caseInstanceId" : null,
    "caseExecutionId" : null,
    "revision" : 0,
    "createTime" : "2024-11-28T06:57:50.778+0000",
    "value" : null,
    "textValue2" : null,
    "type" : null,
    "state" : "CREATED",
    "taskDefinitionKey" : "Global",
    "taskDefinitionName" : "Global",
    "taskDefinitionType" : "processInstance"
  } ],
  "orderId" : "estgjvuk56sc3o34qonmqwlpo3j65kgc"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档