Cancel Flow Instance¶
Cancel the running of a specified workflow instance.
Prerequisites¶
The user must be the owner of the workflow instance.
Both the user and the workflow are not locked.
Request Format¶
POST https://{apigw-address}/batch-processing-service/v2.1/flowInstances
Request Parameters (URI)¶
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|---|
userId |
Query |
Mandatory |
String |
The user ID. How to get userId>> |
orgId |
Query |
Mandatory |
String |
The organization ID which the user belongs to. How to get orgId>> |
action |
Query |
Mandatory |
String |
Fixed value: cancel |
Request Parameters (Body)¶
Name |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
flowInstId |
Mandatory |
String |
The ID of the workflow instance. |
Response Parameters¶
Name |
Data Type |
Description |
|---|---|---|
data |
String |
No results will be returned if the request is successful. |
Error Code¶
See Common Error Codes.
Samples¶
Request Sample¶
url: https://{apigw-address}/batch-processing-service/v2.1/flowInstances?action=cancel&userId={}&orgId={}
method: POST
requestBody:
{
"flowInstId":"2438-201908081020"
}
Return Sample¶
{
"code":0,
"msg":"OK",
"data":""
}
SDK Samples¶
You can access the SDK samples for batch processing service on GitHub: