API

Request a delete of test results

post
https://{hostname}/concerto/services/rest/Results/management/v1

This action submits a background task to delete results. It returns a jobId. Use the jobId to make subsequent calls to track the status of the task.

Body Params

Parameters to determine which test results should be deleted.

string

End of the range of test end times to query for.

string

Start of the range of test end times to query for.

int64
≥ 0
Defaults to 50

Maximum rows to delete. To change the default value of 50, change the repository service's Results.Management.Deletion.Limit setting.

int64
≥ 0

Delete results for test that ran less than or equal to this number of seconds.

string

Delete results which are less than or equal to the specified size. Sizes can be specified in bytes by default, or followed by KB, MB, or GB. For example, 15.4 MB.

int64
≥ 0

Delete results for test that ran greater than or equal to this number of seconds.

string

Delete results which are greater than or equal to the specified size. Sizes can be specified in bytes by default, or followed by KB, MB, or GB. For example, 15.4 MB.

int64
≥ 0
Defaults to 0

Delete results for which it has been more than this number of days since they completed.

boolean
Defaults to true

Enabling this doesn't actually delete any results, but simply reports back what would have been deleted.

string

Name of a results database to limit the result selection. Defaults to all running databases.

string
enum

A result completion status, either Completed, Failed, Stopped, or Aborted. A Stopped status indicates the test was halted but finished writing test data. Aborted indicates the test was halted without writing all test data.

Allowed:
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

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.

404

Not found. The requested object doesn't exist.

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago