Cancel Flow Instance

Cancel the running of a specified workflow instance.

Prerequisites

  1. The user must be the owner of the workflow instance.
  2. Both the user and the workflow are not locked.

Request Format

POST https://{apigw-address}/dataflow-batch-service/v2.0/flowInstances?action=cancel&userId={}&orgId={}

Request Parameters (URI)

Name Location (Path/Query) Required or Not Data Type Description
userId Query true String User ID. How to get userId>>
orgId Query true String Organization ID which the user belongs to. How to get orgId>>

Request Parameters (Body)

Name Required or Not Data Type Description
flowInstId true String ID of the workflow instance

Response Parameters

Name Data Type Description
data String Null string returned if the request is successful

Error Code

See Common Error Codes.

Sample

Request Sample

url: https://{apigw-address}/dataflow-batch-service/v2.0/flowInstances?action=cancel&userId={}&orgId={}

method: POST

{
  "flowInstId":"2438-201908081020"
}

Return Sample

{
"status":0,
"msg":" Success",
"data":""
}

Java SDK Sample

import com.alibaba.fastjson.JSONObject;
import com.envision.apim.poseidon.config.PConfig;
import com.envision.apim.poseidon.core.Poseidon;

public class Request extends PoseidonRequest {
    public void setQueryParam(String key, Object value){
        QueryParams().put(key, value);
    }
    public void setHeaderParam(String key, String value){
        headerParams().put(key, value);
    }
    public void setBodyParam(Map<String, Object> bodyPara){
        bodyParams().putAll(bodyPara);
    }
    public void setMethod(String method) {
        this.method = method;
    }
    private String method;
    public String baseUri() {
        return "";
    }
    public String method() {
        return method;
    }
}

public void cancelFlowInstanceTest(){
    //1. Select Application Registration from the left navigation bar of EnOS Console.
    //2. Open the App Detail page to get the AccessKey and SecretKey of the application.
    String accessKey = "****************";
    String secretKey = "****************";

    //Create a request and save the required parameters in the map of the Query.
    Request request = new Request();
    Map<String,Object> map = new HashMap<>(1);
    map.put("flowInstId","2924-20190812013400);
    request.setQueryParam("userId","your_userId");
    request.setQueryParam("orgId","your_orgId");
    request.setBodyParam(map);
    request.setMethod("post");

    try {
        JSONObject response = Poseidon.config(PConfig.init().appKey(accessKey).appSecret(secretKey).debug())
                .url("https://{apigw-address}/dataflow-batch-service/v2.0/flowInstances?action=cancel")
                .getResponse(request, JSONObject.class);

        System.out.println(response);
    } catch (Exception e) {
        e.printStackTrace();
    }
}