Terminate Process Instance¶

终止流程实例。

请求格式¶

POST https://{apigw-address}/enos-bpm-service/v2.0/work/process-instances?action=delete

请求参数（Header）¶

名称	位置	必需/可选	数据类型	描述
Authorization	Header	必需	String	Access Token，以 Bearer Token 表示，需要通过调用 Log In 或 Refresh Access Token 接口后获取。

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
processInstanceId	Query	必需	String	流程实例 ID。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
deleteReason	必需	String	流程实例终止原因。

响应参数¶

名称	数据类型	描述
data	Boolean	流程实例是否成功终止。

错误码¶

代码	描述
33403	当前用户没有权限终止该流程实例。
33404	流程实例 ID 不存在。
33500	服务内部错误。

示例¶

请求示例¶

url: https://{apigw-address}/enos-bpm-service/v2.0/work/process-instances?action=delete&processInstanceId={your_process_instance_id}

method: POST

headers: {"Authorization":"Bearer {your_access_token}"}

requestBody: {
  "terminateReason": "your_terminate_reason"
}

返回示例¶

{
  "code": 0,
  "msg": "",
  "data": true
}

Java SDK 调用示例¶

public class BpmSdkTest{
    @Test
    public void terminateProcessInstanceTest() {
        String bearerToken = "your_bearer_token";
        String processInstanceId = "process_instance_id";
        String terminateReason = "your_process_terminate_reason";
        ProcessInstanceTerminateRequest request = new ProcessInstanceTerminateRequest(processInstanceId,
                terminateReason, bearerToken);
        ProcessInstanceTerminationResponse response = Poseidon.config(PConfig.init().appKey("your_access_key")
                                                              .appSecret("your_secret_key").debug()).url("https://{apigw-address}")
                                                              .getResponse(request, ProcessInstanceTerminationResponse.class);
        assertNotNull("response cannot be null", response);
    }
}