Cancel a specific task

post https://{env}.gainsystems.com/api/v1/tasks/{id}/cancel

Attempts to cancel a task identified by its ID. Only tasks that haven't entered processing may be cancelled

Responses

400

Double-check your request - you may be missing some query parameters or have provided invalid parameters

401

You are not authenticated to the API

403

You do not have access to this endpoint

404

That route doesn't exist

429

You've exceeded the rate limit

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://env.gainsystems.com/api/v1/tasks/id/cancel \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "TaskId": "string",
3
  "CancelledBy": "string",
4
  "CancelledOn": "string",
5
  "TaskStatus": "string"
6
}

200Task cancellation response