# 撤销流程 - revokeProcessInstance #### 功能介绍 本接口用于撤销已发起的流程实例，适用于终止正在运行的审批流程、生产工单流程或子流程等场景。与[启动流程 - startProcessInstance](https://support.huaweicloud.com/api-idme/startProcessInstance.html)接口配合，可完成流程的全生命周期管理。 #### 接口约束 - 仅支持撤销处于ACTIVE（运行中）状态的流程实例。可通过[查询流程实例列表 - queryProcessesInstanceList](https://support.huaweicloud.com/api-idme/queryProcessesInstanceList.html)接口确认流程状态。 - 调用前需确保流程实例未进入最终状态（如已结束或已取消），否则将产生流程状态冲突异常。 - 撤销操作不可逆，建议在调用前进行人工确认，避免误操作导致业务数据丢失。 - 本接口支持基础版和体验数据建模引擎-流程引擎场景。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-idme/idme_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-idme/idme_api_0017.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /console/servicetask/api/localMethod/assessment_trilogy/revokeProcessInstance #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** IAM用户的token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（即响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | X-Application-Id | 是 | String | **参数解释：** 应用ID。 您可以在应用设计态的"应用中心 \> 应用发布"页面获取，详情请参见[应用发布](https://support.huaweicloud.com/usermanual-idme/idme_usermanual_0085.html)。 **约束限制：** 不涉及。 **取值范围：** 由英文字母和数字组成，且长度为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服务的[获取用户信息](https://support.huaweicloud.com/api-orgid/ShowOauth2UserInfo.html)接口获取。 **约束限制：** 仅基础版数据建模引擎-流程引擎需要配置此参数。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | processInstanceId | 是 | String | **参数解释：** 流程实例ID，用于唯一标识需要撤销的流程实例。可通过[查询流程实例列表 - queryProcessesInstanceList](https://support.huaweicloud.com/api-idme/queryProcessesInstanceList.html)或[启动流程 - startProcessInstance](https://support.huaweicloud.com/api-idme/startProcessInstance.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 最大长度100字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | Integer | **参数解释：** 接口返回码，标识接口调用的执行结果。 **取值范围：** - 200：成功。 - 非200：失败，具体错误码请参见[错误码](https://support.huaweicloud.com/api-idme/WorkFlow-Engine-ErrorCode.html)。 | | data | [data] object | **参数解释：** 接口响应数据，包含流程撤销后的业务返回信息。 **取值范围：** 不涉及。 | | orderID | String | **参数解释：** 请求跟踪流水号，用于唯一标识本次接口请求，便于问题排查和链路追踪。 遇到问题时，请提供此ID联系技术支持。 **取值范围：** 不涉及。 | 表4data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resultInfo | [resultInfo] object | **参数解释：** 流程撤销结果信息，包含撤销成功与失败的流程实例详情。 **取值范围：** 不涉及。 | 表5resultInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | successProcessInstanceIds | Array of strings | **参数解释：** 撤销成功的流程实例ID列表。如果撤销成功，列表中将包含本次请求的"processInstanceId"。 **取值范围：** 不涉及。 | | allSucceeded | Boolean | **参数解释：** 标识本次撤销操作是否全部成功。由于当前接口仅支持单流程实例撤销，该字段实际为单实例操作结果标识。 **取值范围：** - true：撤销成功。 - false：撤销失败，需查看"failedProcessInfos"获取失败原因。 | | failedProcessInfos | Array of strings | **参数解释：** 撤销失败的流程实例信息列表，包含失败原因描述。如果"allSucceeded"为"true"，该字段返回空数组。 **取值范围：** 不涉及。 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | | result | String | 结果。 | | trace_id | String | 追踪ID。 | #### 请求示例 ``` POST https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/console/servicetask/api/localMethod/assessment_trilogy/revokeProcessInstance { "processInstanceId" : "2b263825-e206-11ee-b9f9-7804e3968f51" } ``` #### 响应示例 **状态码：200** OK ``` { "code" : 0, "data" : { "resultInfo" : { "successProcessInstanceIds" : [ "2b263825-e206-11ee-b9f9-7804e3968f51" ], "allSucceeded" : true, "failedProcessInfos" : [ ] } }, "orderID" : "3760534adea441acb7658b8b5cb2c92e" } ``` **状态码：400** Bad Request ``` { "error_code" : "500", "error_msg" : "origin is not allowed!", "result" : "FAIL", "trace_id" : "2509bee60b3e40asdf9f741d9e23466a9" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-idme/WorkFlow-Engine-ErrorCode.html)。