get https://testops.katalon.io/api/v1/executions
A successful request to this endpoint retrieves all test runs in a project given the projectId
and order
values.
Request
This request uses the GET method, which is used to retrieve a list of test runs for a specific project 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:
projectId
: the alphanumeric ID of the test project.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
This API response provides information about a test run or execution.
See the following example:
{
"status": "PASSED",
"startTime": "2022-07-25T16:41:01.233+0000",
"endTime": "2022-07-25T16:41:23.537+0000",
"duration": 22304,
"elapsedDuration": 22304,
"totalTests": 1,
"totalPassedTests": 1,
"totalFailedTests": 0,
"totalErrorTests": 0,
"totalIncompleteTests": 0,
"totalSkippedTests": 0,
"totalDiffTests": 0,
"totalDiffPassedTests": 0,
"totalDiffFailedTests": 0,
"totalDiffErrorTests": 0,
"totalDiffIncompleteTests": 0,
"id": 12014256,
"projectId": 255858,
"project": null,
"order": 865,
"executionStage": "COMPLETED",
"webUrl": "https://testops.katalon.io/team/xxx/project/255858/executions/865",
"testSuiteCollections": [],
"executionTestSuiteResources": [],
"hasComment": false,
"user": {...},
"sessionId": "c758a000-bbaa-4a9f-b5f7-650e3b22d56c",
"type": "KATALON",
"jobs": [],
"useTestCloudTunnel": false
}
Refer to the following table about the response body parameters:
Property | Type | Description | Example value |
---|---|---|---|
status | string | Status of the test run: PASSED , FAILED ERROR , INCOMPLETE , RUNNING , SKIPPED NOT_RUN . | PASSED |
startTime | datetime | The date and time when the test run starts. | 2022-11-01T04:12:30.767+0000 |
endTime | datetime | The date and time when the test run ends. | 2022-11-01T04:12:37.729+0000 |
duration | integer | The sum of execution time of all test cases in the test run (in seconds). | 6962 |
elapsedDuration | integer | The duration between startTime and endTime (in seconds). elapsedDuration might be shorter than duration if the cases are executed concurrently. | 6962 |
totalTests | integer | The total number of test results in the test run. | 5 |
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. | |
projectId | integer | The ID of the project that contains the test run. | 255858 |
project | Project object | The project object associated with the test run. | |
order | integer | The order of the test run. | 865 |
executionStage | string | The stage of the test run: RUNNING , COMPLETED ,TERMINATE ,ANALYZING ,ANALYZED ,IMPORTING ,ERROR . | COMPLETED |
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 associated with the test run. | |
build | BasicBuildResource object | The build associated with the test run. | |
hasComment | boolean | true if the test run has comments. | |
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 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!