You can abort a run by passing the processid to the run abort endpoint. This returns a Status 200 response if the process id was recognized and a 404 response if not.
Method
POST -> http://localhost/api/run/abort
Headers
| Name | Value |
|---|---|
| Authorization | bearer <access_token> |
| Content-Type | application/x-www-form-urlencoded |
Body Parameters
| Name | Type | Required |
|---|---|---|
| id | Integer | Yes |
Possible Responses
| Status | Status Text | Description |
|---|---|---|
| 200 | OK | Execution abort triggered |
| 401 | Unauthorized | The access token was not valid |
| 404 | Not Found | Process was not found with the id passed in |
Response Body JSON
Typical response:
{
"message": "OK",
"description": "Execution abort triggered"
}
| Name | Type | Description |
|---|---|---|
| message | Text | Response status message |
| description | Text | Detailed explanation |
Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2022 Eggplant