撤销流程 - revokeProcessInstance

X-Auth-Token

是

String

参数解释：

IAM用户的token。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Application-Id

是

String

参数解释：

应用ID。

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

约束限制：

不涉及。

取值范围：

由英文字母和数字组成，且长度为32个字符。

默认取值：

不涉及。

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

约束限制：

仅基础版数据建模引擎-流程引擎需要配置此参数。

取值范围：

不涉及。

默认取值：

不涉及。

processInstanceId

是

String

参数解释：

流程实例ID，用于唯一标识需要撤销的流程实例。可通过查询流程实例列表 - queryProcessesInstanceList或启动流程 - startProcessInstance接口获取。

约束限制：

不涉及。

取值范围：

最大长度100字符。

默认取值：

不涉及。

code

Integer

参数解释：

接口返回码，标识接口调用的执行结果。

取值范围：

• 200：成功。

• 非200：失败，具体错误码请参见错误码。

data

data object

参数解释：

接口响应数据，包含流程撤销后的业务返回信息。

取值范围：

不涉及。

orderID

String

参数解释：

请求跟踪流水号，用于唯一标识本次接口请求，便于问题排查和链路追踪。

遇到问题时，请提供此ID联系技术支持。

取值范围：

不涉及。

resultInfo

resultInfo object

参数解释：

流程撤销结果信息，包含撤销成功与失败的流程实例详情。

取值范围：

不涉及。

successProcessInstanceIds

Array of strings

参数解释：

撤销成功的流程实例ID列表。如果撤销成功，列表中将包含本次请求的“processInstanceId”。

取值范围：

不涉及。

allSucceeded

Boolean

参数解释：

标识本次撤销操作是否全部成功。由于当前接口仅支持单流程实例撤销，该字段实际为单实例操作结果标识。

取值范围：

• true：撤销成功。

• false：撤销失败，需查看“failedProcessInfos”获取失败原因。

failedProcessInfos

Array of strings

参数解释：

撤销失败的流程实例信息列表，包含失败原因描述。如果“allSucceeded”为“true”，该字段返回空数组。

取值范围：

不涉及。

error_code

String

错误码。

error_msg

String

错误描述。

result

String

结果。

trace_id

String

追踪ID。

200

OK

400

Bad Request