A successful request to this endpoint retrieves a test result given the id
.
Request
This request uses the GET method, which is used to retrieve information about a specific test result from 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:
id
: the alphanumeric ID of the test result ID. You can find this in the Reports section of Katalon TestOps.
Here's a sample test result object:
{
"id": 156008586,
"testCase": {...},
"execution": {...},
"platform": {...},
"status": "PASSED",
"stdoutId": 335943568,
"descriptionId": 335943569,
"logId": 335943570,
"attachments": [{...}],
"testResultAssertionsFailed": [],
"startTime": "2022-11-25T05:25:14.604+0000",
"endTime": "2022-11-25T05:25:31.272+0000",
"duration": 16668,
"sameFailureResults": [],
"testSuite": {...},
"executionTestSuite": {...},
"incidents": [],
"profile": "default",
"hasComment": false,
"webUrl": "https://testops.katalon.io/team/242852/project/255858/executions/13530835/test-result/156008586-tc1_verify-successful-login",
"externalIssues": [],
"totalDefects": 0,
"totalAssertion": 1,
"passedAssertion": 1,
"failedAssertion": 0,
"retried": false,
"originalStatus": "PASSED",
"statusEdited": false,
"urlId": "156008586-tc1_verify-successful-login"
}
Refer to the following table about the test result object parameters:
Property | Type | Description |
---|---|---|
id | integer | The unique identifier of the test result. |
testCase | test case object | The test case associated with the test result. |
execution | test run object | The test run that contains the test result. |
platform | object | The execution environment of the test case, including: OS, browser, device, etc. |
status | string | The execution status of the associated test case: PASSED , FAILED , ERROR , INCOMPLETE , RUNNING , SKIPPED , NOT_RUN . |
attachments | array of file objects | A list of screenshots and recorded videos to see what went wrong when the test case failed. |
testResultAssertionsFailed | array of failed assertion objects | Failed assertion logs. |
startTime | date-time object | The date and time when the test case execution started. |
endTime | date-time object | The date and time when the test case execution ended. |
duration | integer | How long the test case execution took (in miliseconds). |
errorMessage | string | This message shows the error summary and information about the execution session. |
errorDetail | string | Detailed execution log. |
webUrl | string | The URL of the TestOps page that displays the test result. |
failedTestResultCategory | string | If this is a failed test result, this property shows the failure category: APPLICATION , AUTOMATION , ENVIRONMENT , or UNKNOWN . |
Response
This API response provides a comprehensive summary of the test result, including information about the test case, execution details, platform, attachments, and more.
Here's a template of a response body:
{
"id": 0,
"testCase": {
"id": 0,
"name": "string",
"path": "string",
"alias": "string",
"webUrl": "string",
"description": "string",
"project": {
"id": 0,
"name": "string",
"teamId": 0,
"status": "ARCHIVE"
},
"lastExecutionTestCase": {
"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,
"executionId": 0,
"executionOrder": 0,
"testCaseId": 0,
"projectId": 0
},
"externalIssues": [
{
"id": 0,
"issueId": "string",
"summary": "string",
"status": "string",
"issueTypeIcon": "string",
"issueTypeName": "string",
"url": "string",
"featureName": "string"
}
],
"type": "TEST_CASE",
"averageDuration": 0,
"maxDuration": 0,
"minDuration": 0,
"flakiness": 0,
"maintainer": {
"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"
},
"testResultAssertion": {
"executionTestResultId": 0,
"totalAssertion": 0,
"passedAssertion": 0,
"failedAssertion": 0
},
"updatedAt": "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
},
"numberOfExecutions": 0,
"urlId": "string"
},
"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
},
"platform": {
"id": 0,
"osName": "string",
"osVersion": "string",
"browserName": "string",
"browserVersion": "string",
"deviceName": "string",
"appName": "string"
},
"status": "PASSED",
"sameStatusPeriod": 0,
"errorDetailsId": 0,
"stdoutId": 0,
"descriptionId": 0,
"logId": 0,
"attachments": [
{
"id": 0,
"uploadFileId": 0,
"self": "string",
"name": "string",
"path": "string",
"url": "string",
"hash": "string",
"size": 0,
"uploadUrl": "string",
"signedUrl": "string",
"thumbnailUrl": "string"
}
],
"testResultAssertionsFailed": [
{
"id": 0,
"executionTestResultId": 0,
"stacktrace": "string",
"message": "string",
"logTime": "string"
}
],
"startTime": "2023-09-12T09:50:00.573Z",
"endTime": "2023-09-12T09:50:00.573Z",
"duration": 0,
"sameFailureResults": [
{
"id": 0,
"executionId": 0,
"urlId": "string"
}
],
"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"
},
"executionTestSuite": {
"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"
},
"profile": "string",
"hasComment": true,
"errorMessage": "string",
"errorDetail": "string",
"webUrl": "string",
"externalIssues": [
{
"id": 0,
"issueId": "string",
"summary": "string",
"status": "string",
"issueTypeIcon": "string",
"issueTypeName": "string",
"url": "string",
"featureName": "string"
}
],
"failedTestResultCategory": "APPLICATION",
"totalTestObject": 0,
"totalDefects": 0,
"totalAssertion": 0,
"passedAssertion": 0,
"failedAssertion": 0,
"retried": true,
"lastRetryTestId": 0,
"currentRetry": 0,
"originalStatus": "PASSED",
"lastChangedBy": {
"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"
},
"errorKeyword": "string",
"urlId": "string",
"statusEdited": true
}
Refer to the following table about the response body parameters:
Property | Type | Description |
---|---|---|
id | integer | The unique identifier of the test result id. |
testCase | testCase object | Information about the test case associated with this test result, including its name, path, description, and more. |
execution | execution object | Details related to the execution of the test, including its status, start time, end time, and various counts related to tests. |
platform | platform object | Information about the platform on which the test was executed, including the operating system, browser, device, and application name. |
path | string | The file folder location of the test case in TestOps. |
alias | string | The alias for the test class used in a test script. |
webUrl | string | The URL of the test case detail page. |
project | project object | The project object associated with the test case. |
lastExecutionTestCase | lastExecutionTestCase object | This object contains details of the latest execution of a test case, including execution status, total tests executed, duration, execution ID, and start and end times. |
externalIssues | Array of externalIssues objects | |
averageDuration | integer | The mean average time running an execution in a test case. |
maxDuration | integer | The maximum time it takes for an execution to run in a test case. |
minDuration | integer | The shortest or minimum time it takes for an execution to run in a test case. |
flakiness | integer | The number of times the status of test results changes over the total number of test results. |
testResultAssertion | Array of testResultAssertion objects | Test case assertion logs or scripts. |
updatedAt | string | The date and time when the test case was last updated. |
numberOfExecutions | integer | The number of executions done in the test case. |
urlId | string | The unique URL identifier of a test case. |
Try it!
- Enter the Test Result ID below.
- Select the language in Language.
- Enter your user name or API credentials.
- Review your API call and click Try it!