A successful request to this endpoint permanently deletes multiple test runs. The response lists the details of the deleted test runs.
Request
This request uses the DELETE method, which is used to delete a specific test run or execution in progress in Katalon TestOps via the specified resource. You can also use the same resource to delete multiple test runs or executions associated with a specific project.
For basic authorization, replace this with your actual username and password (or API key) in the header request in the username:password or username:api_key format. Your user creds are combined to form a Base64 encoded string.
The request data is provided as a JSON object. You need to provide the following required query parameters:
projectId: The alphanumeric ID of the test run.order: The order value of the test run. Test runs are ordered in a list from first to last executed. You can find this in the Reports section of Katalon TestOps. The nth test run in a project would have an order value of n.
Response
If authorized, the API provides detailed information about an execution or test run and other details.
Here's a structured template of an API response for a DELETE request:
[
{
"status": "PASSED",
"startTime": "2023-09-12T09:50:00.573Z",
"endTime": "2023-09-12T09:50:00.573Z",
"duration": 0,
"elapsedDuration": 0,
"totalTests": 0,
"totalPassedTests": 0,
"totalFailedTests": 0,
"totalErrorTests": 0,
"totalIncompleteTests": 0,
"totalSkippedTests": 0,
"totalDiffTests": 0,
"totalDiffPassedTests": 0,
"totalDiffFailedTests": 0,
"totalDiffErrorTests": 0,
"totalDiffIncompleteTests": 0,
"id": 0,
"projectId": 0,
"project": {
"id": 0,
"name": "string",
"teamId": 0,
"status": "ARCHIVE"
},
"buildId": 0,
"order": 0,
"executionStage": "RUNNING",
"webUrl": "string",
"testSuiteCollections": [
{
"id": 0,
"name": "string",
"project": {
"id": 0,
"name": "string",
"teamId": 0,
"team": {
"id": 0,
"name": "string",
"organization": {
"id": 0,
"name": "string",
"role": "OWNER",
"orgFeatureFlag": {
"organizationId": 0,
"subDomain": true,
"strictDomain": true,
"sso": true,
"whitelistIp": true,
"testOpsIntegration": true
},
"quotaKSE": 0,
"machineQuotaKSE": 0,
"quotaUnlimitedKSE": 0,
"quotaEngine": 0,
"machineQuotaEngine": 0,
"quotaUnlimitedEngine": 0,
"usedKSE": 0,
"usedUnlimitedKSE": 0,
"usedEngine": 0,
"usedUnlimitedEngine": 0,
"quotaTestOps": 0,
"usedTestOps": 0,
"numberUser": 0,
"quotaFloatingEngine": 0,
"usedFloatingEngine": 0,
"canCreateOfflineKSE": true,
"canCreateOfflineUnlimitedKSE": true,
"canCreateOfflineRE": true,
"canCreateOfflineUnlimitedEngine": true,
"subscriptionExpiryDateEngine": "2023-09-12T09:50:00.573Z",
"subscriptionExpiryDateUnlimitedEngine": "2023-09-12T09:50:00.573Z",
"subscriptionExpiryDateKSE": "2023-09-12T09:50:00.573Z",
"subscriptionExpiryDateUnlimitedKSE": "2023-09-12T09:50:00.573Z",
"subscriptionExpiryDateFloatingEngine": "2023-09-12T09:50:00.573Z",
"subscriptionExpiryDateTestOps": "2023-09-12T09:50:00.573Z",
"subscribed": true,
"ksePaygo": true,
"krePaygo": true,
"paygoQuota": 0,
"domain": "string",
"subdomainUrl": "string",
"strictDomain": true,
"logoUrl": "string",
"samlSSO": true,
"kreLicense": true,
"mostRecentProjectAccessedAt": "2023-09-12T09:50:00.573Z",
"testOpsFeature": "KSE",
"platformFeature": "KSE",
"tier": "FREE",
"requestedUserVerified": true
},
"organizationId": 0
},
"timezone": "string",
"status": "ARCHIVE"
},
"path": "string",
"urlId": "string"
}
],
"executionTestSuiteResources": [
{
"status": "PASSED",
"startTime": "2023-09-12T09:50:00.573Z",
"endTime": "2023-09-12T09:50:00.573Z",
"duration": 0,
"elapsedDuration": 0,
"totalTests": 0,
"totalPassedTests": 0,
"totalFailedTests": 0,
"totalErrorTests": 0,
"totalIncompleteTests": 0,
"totalSkippedTests": 0,
"id": 0,
"execution": {
"status": "PASSED",
"startTime": "2023-09-12T09:50:00.573Z",
"endTime": "2023-09-12T09:50:00.573Z",
"duration": 0,
"elapsedDuration": 0,
"totalTests": 0,
"totalPassedTests": 0,
"totalFailedTests": 0,
"totalErrorTests": 0,
"totalIncompleteTests": 0,
"totalSkippedTests": 0,
"id": 0,
"projectId": 0,
"buildId": 0,
"order": 0,
"executionStage": "RUNNING",
"hasComment": true,
"sessionId": "string",
"buildLabel": "string",
"buildUrl": "string",
"type": "KATALON",
"useTestCloudTunnel": true
},
"testSuite": {
"id": 0,
"name": "string",
"path": "string",
"alias": "string",
"updatedAt": "2023-09-12T09:50:00.573Z",
"createdAt": "2023-09-12T09:50:00.573Z",
"type": "KATALON_STUDIO",
"urlId": "string"
},
"platform": {
"id": 0,
"osName": "string",
"osVersion": "string",
"browserName": "string",
"browserVersion": "string",
"deviceName": "string",
"appName": "string"
},
"executionId": 0,
"profiles": [
"string"
],
"urlId": "string"
}
],
"release": {
"id": 0,
"name": "string",
"startTime": "2023-09-12",
"endTime": "2023-09-12",
"description": "string",
"projectId": 0,
"closed": true,
"createdAt": "2023-09-12T09:50:00.573Z",
"releaseStatus": "NOT_READY"
},
"build": {
"id": 0,
"projectId": 0,
"releaseId": 0,
"name": "string",
"description": "string",
"date": "2023-09-12T09:50:00.573Z"
},
"hasComment": true,
"user": {
"id": 0,
"email": "string",
"firstName": "string",
"lastName": "string",
"password": "string",
"invitingUrl": "string",
"trialExpirationDate": "2023-09-12T09:50:00.573Z",
"surveyStatus": "NOT_SUBMITTED",
"sessionTimeout": 0,
"businessUser": true,
"canCreateOfflineKSE": true,
"canCreateOfflineRE": true,
"samlSSO": true,
"createdAt": "2023-09-12T09:50:00.573Z",
"fullName": "string"
},
"sessionId": "string",
"buildLabel": "string",
"buildUrl": "string",
"type": "KATALON",
"jobs": [
{
"id": 0,
"buildNumber": 0,
"status": "QUEUED",
"queuedAt": "2023-09-12T09:50:00.573Z",
"startTime": "2023-09-12T09:50:00.573Z",
"stopTime": "2023-09-12T09:50:00.573Z",
"testProject": {
"id": 0,
"name": "string",
"description": "string",
"defaultTestProject": true,
"uploadFileId": 0,
"projectId": 0,
"teamId": 0,
"createdAt": "2023-09-12T09:50:00.573Z",
"uploadFileName": "string",
"type": "KS",
"dirty": true
},
"agent": {
"id": 0,
"name": "string",
"ip": "string",
"uuid": "string",
"lastPing": "2023-09-12T09:50:00.573Z",
"os": "string",
"teamId": 0,
"hostname": "string",
"active": true,
"threshold": 0,
"numExecutingJobs": 0,
"numAssignedJobs": 0,
"agentVersion": "string",
"deleted": true
},
"testCloudAgent": {
"id": 0,
"name": "string",
"os": "string",
"osVersion": "string",
"browser": "string",
"browserVersion": "string",
"deviceName": "string",
"appId": "string",
"appGroupId": "string",
"appName": "string",
"numExecutingJobs": 0,
"numAssignedJobs": 0,
"teamId": 0,
"deleted": true,
"apiKey": "string",
"totalDuration": 0,
"headless": true
},
"k8sAgent": {
"id": 0,
"name": "string",
"certificateAuthority": "string",
"url": "string",
"namespace": "string",
"username": "string",
"password": "string",
"token": "string",
"cluster": "string",
"region": "string",
"accessKey": "string",
"privateAccessKey": "string",
"teamId": 0,
"apiKey": "string",
"authenticationType": "BASIC_AUTH"
},
"circleCiAgent": {
"id": 0,
"name": "string",
"url": "string",
"username": "string",
"token": "string",
"project": "string",
"vcsType": "string",
"branch": "string",
"teamId": 0,
"apiKey": "string"
},
"runConfiguration": {
"id": 0,
"name": "string",
"command": "string",
"projectId": 0,
"teamId": 0,
"testProjectId": 0,
"releaseId": 0,
"testSuiteCollectionId": 0,
"testSuiteId": 0,
"executionProfileId": 0,
"baselineCollectionGroupOrder": 0,
"timeOut": 0,
"kobitonDeviceId": "string",
"configType": "TSC",
"cloudType": "K8S",
"genericCommand": "string",
"ksVersion": "string",
"ksLocation": "string",
"executionMode": "SEQUENTIAL",
"enabledKobitonIntegration": true,
"enabledTestCloudTunnel": true,
"triggerMode": "TESTOPS_SCHEDULER",
"browserType": "CHROME"
},
"order": 0,
"triggerBy": "MANUAL",
"duration": 0,
"triggerAt": "2023-09-12T09:50:00.573Z",
"scheduler": {
"id": 0,
"name": "string",
"startTime": "2023-09-12T09:50:00.573Z",
"nextTime": "2023-09-12T09:50:00.573Z",
"endTime": "2023-09-12T09:50:00.573Z",
"active": true,
"interval": 0,
"intervalUnit": "MINUTE",
"runConfigurationId": 0,
"exceededLimitTime": true
},
"processId": 0,
"nodeStatus": "PENDING_CANCELED",
"runConfigurationId": 0
}
],
"useTestCloudTunnel": true,
"kEyesExecution": {
"id": 0,
"status": "RUNNING",
"execution": {
"status": "PASSED",
"startTime": "2023-09-12T09:50:00.573Z",
"endTime": "2023-09-12T09:50:00.573Z",
"duration": 0,
"elapsedDuration": 0,
"totalTests": 0,
"totalPassedTests": 0,
"totalFailedTests": 0,
"totalErrorTests": 0,
"totalIncompleteTests": 0,
"totalSkippedTests": 0,
"id": 0,
"projectId": 0,
"buildId": 0,
"order": 0,
"executionStage": "RUNNING",
"hasComment": true,
"sessionId": "string",
"buildLabel": "string",
"buildUrl": "string",
"type": "KATALON",
"useTestCloudTunnel": true
},
"totalCheckpoints": 0,
"passedCheckpoints": 0,
"failedCheckpoints": 0,
"unresolvedCheckpoints": 0,
"unsaved": true
}
}
]Refer to the following table about the response body's properties:
Property | Type | Description |
|---|---|---|
| String | Status of the test run: |
| String | The date and time when the test run starts. |
| String | The date and time when the test run ends. |
| Integer | The sum of execution time of all test cases in the test run (in seconds). |
| Integer | The duration between |
| Integer | The total number of test results in the test run. |
| Integer | The total number of test results with the |
| Integer | The total number of test results with the |
| Integer | The total number of test results with the |
| Integer | The total number of test results with the |
| Integer | The total number of test results with the |
| Integer | The unique identifier of the test run. |
| Object | The |
| String | The stage of the test run: |
| String | The URL of of test run detail page. |
| Array | An array of test suite collections associated with the test run. |
| Array | An array of test suites that are executed in this test run. |
| Object | The release that is associated with the test run. |
| Object | The build associated with the test run. |
| Object | The user that creates the test run. |
| String | The UUID generated for the test run. TestOps does not use this UUID to identify the test run. |
| String | The build label specified in the execution command to associate the test run with a specific build. |
| String | The build URL specified in the execution command to associate the test run with a specific build. |
| String | There are two test run types: |
| Array | An array of scheduled jobs that execute test cases in the test run. |
| Boolean |
|
| Object | This object represents the Visual Testing execution results. |
Try it!
- Enter the project ID and order value below.
- Select the language in Language.
- Enter your user name or API credentials.
- Review your API call and click Try it!