Initiate tenant sub-data deletion

This action submits a background task to delete results and monitors under given tenant for passed auth token. It returns a jobId. Use the jobId to make subsequent calls to track the status of the task.

Path Params
string
required

Specifies the tenant to delete the results and monitor.

Headers
string
required

All calls to this API require that you pass in the token you get from the Generate a token operation as an X-Auth-Token request header. See Get started for help to initially call the API.

Responses

Response body
object
string
required

The status of the task, either SCHEDULED, STARTED, COMPLETED, STOPPED, or ERROR. SCHEDULED indicates a job which has not yet started. STARTED shows a job which is currently running. COMPLETED is for a job which has completed its work. STOPPED indicates a job which was stopped while running or while scheduled. ERROR is for a job which ended in an error which will be returned on GET operations.

SCHEDULED STARTED COMPLETED STOPPED ERROR

int64
required
≥ 1

Uniquely identifies each task.

string
required

Use this URL to get the status of the given job.

400

Bad request. The URL or JSON request object is invalid.

401

Unauthorized. The security token is missing or invalid. See Get started for help initially running the API.

403

Forbidden. The authenticated user does not have access to this resource.

404

Not found. The requested object doesn't exist.

Language
Authentication
URL