Cancel a specific task

post

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

Withdraws a task that has not started processing. A task in Received, Queued or PendingReview can be cancelled; once it is Processing, it can no longer be cancelled.

Use this to withdraw a deletion request that has not been approved yet: the held records are discarded and no approval is needed. An unknown TaskId returns 400.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

200Request succeeded

400Malformed request, unknown field, or failed validation

401Credentials missing or not valid: a wrong user name or password, an invalid or expired token, or Basic credentials on an endpoint that accepts only a Bearer token

403Your credentials do not have the permission this endpoint requires, or the GAINS X connection is not enabled for your environment

426The connected GAINS X version does not support this endpoint. The body states the current version and the version required

500Unexpected server error

503GAINS is temporarily unavailable: GAINS X could not be reached or returned an error, a scheduled GAINS process is running, or your credentials could not be checked. Retry later

504GAINS X did not respond in time. Retry later