post https://testops.katalon.io/api/v1/executions/terminate
A successful request to this endpoint terminates a test run in progress. This method returns the details of the test run you terminated.
Request
This request uses the POST method, which is used to terminate a specific test run or execution in progress in Katalon TestOps via the specified resource.
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 within a testing or quality assurance platform.
See the following example:
The following example is only a sample response, and many of the values in this example are set to default or placeholder values. It is essential to review the actual data when using this response in a real-world scenario.
{
"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 parameters:
| Property | Type | Description |
|---|---|---|
status | string | Status of the test run: PASSED, FAILED ERROR, INCOMPLETE, RUNNING, SKIPPED NOT_RUN. |
startTime | datetime | The date and time when the test run starts. |
endTime | datetime | The date and time when the test run ends. |
duration | integer | The sum of execution time of all test cases in the test run (in seconds). |
elapsedDuration | integer | The duration between startTime and endTime (in seconds). elapsedDuration might be shorter than duration if the cases are executed concurrently. |
totalTests | integer | The total number of test results in the test run. |
totalPassedTests | integer | The total number of test results with the PASSED status. |
totalFailedTests | integer | The total number of test results with the FAILED status. |
totalErrorTests | integer | The total number of test results with the ERROR status. |
totalInCompleteTests | integer | The total number of test results with the INCOMPLETE status. |
totalSkippedTests | integer | The total number of test results with the SKIPPED status. |
id | integer | The unique identifier of the test run. |
project | Project object | The project object associated with the test run. |
executionStage | string | The stage of the test run: RUNNING, COMPLETED,TERMINATE,ANALYZING,ANALYZED,IMPORTING,ERROR. |
webUrl | string | The URL of of test run detail page. |
testSuiteCollections | array of GetTestSuiteCollectionEntity objects | The test suite collections associated with the test run. |
executionTestSuiteResources | array of GetExecutionTestSuite objects | The test suites that are executed in this test run. |
release | BasicReleaseResource object | The release that is associated with the test run. |
build | BasicBuildResource object | The build associated with the test run. |
user | BasicUserResource object | The user that creates the test run. |
sessionId | string | The UUID generated for the test run. TestOps does not use this UUID to identify the test run. |
buildLabel | string | The build label specified in the execution command to associate the test run with a specific build. See: TestOps integration arguments. |
buildUrl | string | The build URL specified in the execution command to associate the test run with a specific build. See: TestOps integration arguments. |
type | string | There are two test run types: KATALON and BDD. |
jobs | array of BasicJobResource objects | The scheduled jobs that execute test cases in the test run. |
useTestCloudTunnel | boolean | true if the test run is executed with TestCloud Tunnel. |
kEyesExecution | GetKEyesExecution object | This object represents the Visual Testing execution results. |
Try it!
- Enter the test run 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!