Updated Step Settings & Added APIs for Results

src/left-nav-title.json

@@ -673,5 +673,6 @@
   },
   "error-handling": {
     "/docs/salesforce-testing/error-handling/": "Error Handling On Metadata Refresh"
-  }
+  },
+  "test-results-at-all-levels": { "/docs/api/test-results-at-all-levels/": "Fetch Test Results (All Levels)" }
 }

src/pages/docs/api/examples/rerun-test-cases-in-test-run.md

@@ -3,7 +3,7 @@ title: "Rerun Test Cases from Run Results using API"
 page_title: "Rerun Test Cases from Run Results using APII"
 metadesc: "Learn in detail how to rerun failed test cases, all test cases, or custom test cases from a particular test run result in Testsigma using REST API."
 noindex: false
-order: 21.67
+order: 21.87
 page_id: "Rerun Test Cases from a Test Run"
 warning: false
 contextual_links:

src/pages/docs/api/examples/run-the-same-test-plan-multiple-times-in-parallel.md

@@ -1,8 +1,8 @@
 ---
-title: "Run the same Test Plan multiple times in Parallel"
+title: "Run the Same Test Plan Multiple Times in Parallel"
 metadesc: "This document discusses how one test plan can be run multiple times, in parallel, using the REST API calls | Run same test plan multiple times"
 noindex: false
-order: 21.63
+order: 21.83
 page_id: "Run the same Test Plan multiple times in Parallel"
 search_keyword: ""
 warning: false

src/pages/docs/api/examples/schedule-test-plan-with-API.md

@@ -1,9 +1,9 @@
 ---
-title: "Schedule, Update and Delete a test plan using API"
+title: "Schedule, Update & Delete a Test Plan Using API"
 page_title: "Schedule a test plan using API"
 metadesc: "With Testsigma, you can create, update, and delete a schedule for test plan using API. Learn how to schedule, update and delete a test plan using REST API"
 noindex: false
-order: 21.64
+order: 21.84
 page_id: "Schedule, Update and Delete a test plan using API"
 warning: false
 contextual_links:

src/pages/docs/api/examples/trigger-multiple-test-plans.md

@@ -2,7 +2,7 @@
 title: "Trigger Multiple Test Plans Consecutively"
 metadesc: "How to trigger multiple Test Plans remotely using REST API. With this you can run a Mobile Test Plan after executing a Web Test Plan"
 noindex: false
-order: 21.61
+order: 21.81
 page_id: "Trigger Multiple Test Plans Consecutively"
 search_keyword: ""
 warning: false

src/pages/docs/api/examples/trigger-test-plan-wait-completion.md

@@ -1,8 +1,8 @@
 ---
-title: "Trigger Test Plan remotely and wait until Completion"
+title: "Trigger Test Plans Remotely & Wait Until Completion"
 metadesc: "This article discusses in detail on how to trigger a Test Plan remotely using REST API and wait until the Test Run completion before publishing the test results"
 noindex: false
-order: 21.62
+order: 21.82
 page_id: "Trigger Test Plan remotely and wait until Completion"
 search_keyword: ""
 warning: false

src/pages/docs/api/examples/update-test-case-results-using-API.md

@@ -1,9 +1,9 @@
 ---
-title: "Update Test Case results using API"
+title: "Update Test Case Results Using API"
 page_title: "Update Test Case results using API"
 metadesc: "This article discusses in detail on how to update Test Case results as Passed, Failed, and Not Executed using API using REST API in Testsigma."
 noindex: false
-order: 21.65
+order: 21.85
 page_id: "Update Test Case results using API"
 warning: false
 ---

src/pages/docs/api/examples/values-of-test-data-profile.md

@@ -3,7 +3,7 @@ title: "Create and update values of Test Data Profile using REST API"
 page_title: "Update Test Case results using API"
 metadesc: "Learn how to create, update, and delete values of Test Data Profile using REST API in Testsigma | Detailed steps to create, update, and delete values of Test Data Profile"
 noindex: false
-order: 21.66
+order: 21.86
 page_id: "Create, update, and delete values of Test Data Profile using API"
 warning: false
 contextual_links:

src/pages/docs/api/get-project-wide-information.md

@@ -1,5 +1,5 @@
 ---
-title: "Get Project wide information"
+title: "Get Project Wide Information"
 page_title: "Get information for your Testsigma Project"
 metadesc: "Learn how to get detailed information for your Testsigma Project - users, suites, tags, requirement, and testcase priority using APIs"
 noindex: false

src/pages/docs/api/test-results-at-all-levels.md

@@ -0,0 +1,234 @@
+---
+title: "Fetch Test Results at all Levels Using APIs"
+page_title: "Test Results at all Levels Using APIs"
+metadesc: "This article discusses how to fetch test results at test plan, test machine, test suite, test case, and step levels using APIs in Testsigma Application."
+noindex: false
+order: 21.7
+page_id: "Test Results at all Levels Using APIs"
+warning: false
+contextual_links:
+- type: section
+  name: "Contents"
+- type: link
+  name: "Prerequisites"
+  url: "#prerequisites"
+- type: link
+  name: "Fetch Test Plan Details"
+  url: "#fetch-test-plan-details"
+- type: link
+  name: "Fetch Test Machine Details"
+  url: "#fetch-test-machine-details"
+- type: link
+  name: "Fetch Test Suite Details"
+  url: "#fetch-test-suite-details"
+- type: link
+  name: "Fetch Test Case Details"
+  url: "#fetch-test-case-details"
+- type: link
+  name: "Fetch Test Step Details"
+  url: "#fetch-test-step-details"
+---
+
+---
+
+You can leverage Testsigma APIs to fetch detailed test results at all levels. Whether you need results for an entire test plan, a specific test machine, a test suite, an individual test case, or even the test step level, Testsigma's APIs give you the necessary endpoints to get this data. This article discusses how to fetch these results in Testsigma. 
+
+
+---
+
+## **Prerequisites**
+
+- You should have an API Key. See, [generate API Keys in Testsigma](https://testsigma.com/docs/configuration/api-keys/).
+- You should have a [Test Plan Run ID](https://testsigma.com/docs/api/test-plans/#obtaining-the-run-id)
+
+---
+
+## **Fetch Test Plan Details**
+
+| **Request Type** | **GET** |
+|----------|----------|
+| **Endpoint**   | ```https://app.testsigma.com/api/v3/test_runs/<run_id>``` |
+| **Authorization**   | Bearer Token |
+| **Response Body Type**   | JSON   |
+| **Response Body**   | { <br> "id": 517, <br> "testPlanId": 420, <br> "buildNo": null, <br> "result": "FAILURE", <br> "startTime": "2024-05-29T07:29:19Z", <br> "endTime": "2024-05-29T07:33:17Z", <br> "duration": 238000, <br> "executor": "[email protected]", <br> "triggeredType": "MANUAL", <br> "metrics": { <br> "id": 162, <br> "testPlanResultId": 517, <br> "totalCount": 8, <br> "failedCount": 4, <br> "passedCount": 4, <br> "stoppedCount": 0, <br> "notExecutedCount": 0, <br> "queuedCount": 0, <br> "runningCount": 0, <br> "consolidatedPlanTotalCount": 8, <br> "consolidatedPlanFailedCount": 4, <br> "consolidatedPlanPassedCount": 4, <br> "consolidatedPlanStoppedCount": 0, <br> "consolidatedPlanNotExecutedCount": 0, <br> "consolidatedPlanQueuedCount": 0, <br> "consolidatedPlanRunningCount": 0, <br> "result": "FAILURE", <br> "latestResult": "FAILURE", <br> "duration": 226000, <br> "consolidatedDuration": 226000 <br> } <br> } |
+
+In the response body above, we fetched the test plan results with ID 517.
+
+<br>
+
+**INDEX:**
+
+```
+URL: /api/v2/test_runs?query=<TS_QUERY>&page=<number>
+TYPE: GET
+TS_QUERY: <parameter><operator><value> chained with , (ex: query=testPlanId:1,result:PASSED)
+
+operator:
+
+: = EQUAL
+! = NOT EQUAL
+> = GRATER THAN
+< = LESS THAN
+~ = LIKE
+@ = IN
+; = NOT IN
+$ = CONTAINS
+
+STATUS: 200/401/500/400
+
+pagination: { page: <number>, pageSize: <number>, isLast: <boolean>, totalElements: <number> }
+
+```
+
+---
+
+## **Fetch Test Machine Details**
+
+
+| **Request Type** | **GET** |
+|----------|----------|
+| **Endpoint**   | ```https://app.testsigma.com/api/v3/test_runs/<run_id>/test_machine_results/<machine_result_id>``` |
+| **Authorization**   | Bearer Token |
+| **Response Body Type**   | JSON   |
+| **Response Body**   | { <br> "id": 1434, <br> "testRunId": 517, <br> "result": "FAILURE", <br> "startTime": "2024-05-29T07:29:19Z", <br> "endTime": "2024-05-29T07:31:40Z", <br> "duration": 141000, <br> "deviceConfiguration": { <br> "title": "Windows Chrome", <br> "osVersion": "11", <br> "browser": "GoogleChrome", <br> "browserVersion": "123.0", <br> "resolution": "1920x1080", <br> "platform": "Windows", <br> "deviceName": null, <br> "hostName": "agent.testsigma.com", <br> "osType": "WINDOWS" <br> }, <br> "metrics": { <br> "id": 165, <br> "testDeviceResultId": 1434, <br> "testPlanResultId": 517, <br> "totalCount": 4, <br> "failedCount": 2, <br> "passedCount": 2, <br> "stoppedCount": 0, <br> "notExecutedCount": 0, <br> "queuedCount": 0, <br> "runningCount": 0, <br> "consolidatedTotalCount": 4, <br> "consolidatedFailedCount": 2, <br> "consolidatedPassedCount": 2, <br> "consolidatedStoppedCount": 0, <br> "consolidatedNotExecutedCount": 0, <br> "consolidatedQueuedCount": 0, <br> "consolidatedRunningCount": 0, <br> "result": "FAILURE", <br> "latestResult": "FAILURE", <br> "duration": 129000, <br> "consolidatedDuration": 129000 <br> }, <br> "appDetails": null <br> } |
+
+In the response body above, we fetched the test machine results with ID 1434. 
+
+**INDEX:**
+
+```
+URL: /api/v2/test_runs/{run_id}/test_machine_results?query=<TS_QUERY>&page=<number>
+TYPE: GET
+TS_QUERY: <parameter><operator><value> chained with , (ex: query=result:PASSED)
+
+operator:
+
+: = EQUAL
+! = NOT EQUAL
+> = GRATER THAN
+< = LESS THAN
+~ = LIKE
+@ = IN
+; = NOT IN
+$ = CONTAINS
+
+STATUS: 200/401/500/400 
+
+pagination: { page: <number>, pageSize: <number>, isLast: <boolean>, totalElements: <number> }
+
+```
+
+---
+
+## **Fetch Test Suite Details**
+
+| **Request Type** | **GET** |
+|----------|----------|
+| **Endpoint**   | ```https://app.testsigma.com/api/v3/test_runs/<run_id>/test_suite_results/<suite_id>``` |
+| **Authorization**   | Bearer Token |
+| **Response Body Type**   | JSON   |
+| **Response Body**   | { <br> "id": 1383, <br> "suiteId": 359, <br> "testRunId": 517, <br> "testMachineRunId": 1434, <br> "startTime": "2024-05-29T07:29:19Z", <br> "endTime": "2024-05-29T07:30:33Z", <br> "duration": 74000, <br> "result": "FAILURE", <br> "metrics": { <br> "id": 293, <br> "testSuiteResultId": 1383, <br> "testDeviceResultId": 1434, <br> "testPlanResultId": 517, <br> "totalCount": 2, <br> "failedCount": 1, <br> "passedCount": 1, <br> "stoppedCount": 0, <br> "notExecutedCount": 0, <br> "queuedCount": 0, <br> "runningCount": 0, <br> "consolidatedTotalCount": 2, <br> "consolidatedFailedCount": 1, <br> "consolidatedPassedCount": 1, <br> "consolidatedStoppedCount": 0, <br> "consolidatedNotExecutedCount": 0, <br> "consolidatedQueuedCount": 0, <br> "consolidatedRunningCount": 0, <br> "result": "FAILURE", <br> "latestResult": "FAILURE", <br> "duration": 62000, <br> "consolidatedDuration": 62000 <br> } <br> } |
+
+In the response body above, we fetched the test suite results with ID 1383.
+
+
+**INDEX:**
+
+```
+URL: /api/v2/test_runs/{run_id}/test_suite_results?query=<TS_QUERY>&page=<number>
+TYPE: GET
+TS_QUERY: <parameter><operator><value> chained with , (ex: query=result:PASSED)
+
+operator:
+
+: = EQUAL
+! = NOT EQUAL
+> = GRATER THAN
+< = LESS THAN
+~ = LIKE
+@ = IN
+; = NOT IN
+$ = CONTAINS
+
+STATUS: 200/401/500/400
+
+pagination: { page: <number>, pageSize: <number>, isLast: <boolean>, totalElements: <number> }
+
+```
+
+---
+
+## **Fetch Test Case Details**
+
+| **Request Type** | **GET** |
+|----------|----------|
+| **Endpoint**   | ```https://app.testsigma.com/api/v3/test_runs/<run_id>/test_case_results/<case_result_id>``` |
+| **Authorization**   | Bearer Token |
+| **Response Body Type**   | JSON   |
+| **Response Body**   | { <br> "id": 3857, <br> "testCaseId": 609, <br> "startTime": "2024-05-29T07:29:31Z", <br> "endTime": "2024-05-29T07:29:55Z", <br> "duration": 23038, <br> "result": "FAILURE", <br> "isDisabled": false, <br> "isDataDriven": false, <br> "metrics": { <br> "id": 1089, <br> "testCaseResultId": 3857, <br> "testSuiteResultId": 1383, <br> "testDeviceResultId": 1434, <br> "testPlanResultId": 517, <br> "totalCount": 6, <br> "failedCount": 1, <br> "passedCount": 3, <br> "stoppedCount": 0, <br> "notExecutedCount": 2, <br> "queuedCount": 0, <br> "skippedCount": 0, <br> "runningCount": 0, <br> "result": "FAILURE", <br> "latestResult": "FAILURE", <br> "duration": 23038, <br> "consolidatedDuration": 23038 <br> } <br> } |
+
+In the response body above, we fetched the test case results with ID 3857.
+
+**INDEX:**
+
+```
+URL: /api/v2/test_runs/{run_id}/test_case_results?query=<TS_QUERY>&page=<number>
+TYPE: GET
+TS_QUERY: <parameter><operator><value> chained with , (ex: query=result:PASSED)
+
+operator:
+
+: = EQUAL
+! = NOT EQUAL
+> = GRATER THAN
+< = LESS THAN
+~ = LIKE
+@ = IN
+; = NOT IN
+$ = CONTAINS
+
+STATUS: 200/401/500/400
+
+pagination: { page: <number>, pageSize: <number>, isLast: <boolean>, totalElements: <number> }
+
+```
+
+---
+
+## **Fetch Test Step Details**
+
+
+| **Request Type** | **GET** |
+|----------|----------|
+| **Endpoint**   | ```https://app.testsigma.com/api/v3/test_runs/<run_id>/test_case_results/<case_id>/step_results/``` |
+| **Authorization** | Bearer Token |
+| **Response Body Type**   | JSON   |
+| **Response Body** | { <br> "content": [ <br> { "id": "3c51e933-7e15-41a0-893b-38e38b8258a2", <br> "testMachineResultId": 1434, <br> "testCaseResultId": 3857, <br> "testCaseId": 609, <br> "stepId": 2847, <br> "type": "NLP\_TEXT", <br> "action": "Navigate to https://simply-travel.testsigma.com/", <br> "message": "Successfully opened given URL.", <br> "errorCode": null, <br> "errorType": null, <br> "result": "SUCCESS", <br> "conditionalResult": null, <br> "visualTestResult": null, <br> "startTime": "2024-05-29T07:29:32Z", <br> "endTime": "2024-05-29T07:29:33Z", <br> "duration": 1133, <br> "visualEnabled": false }, <br> { "id": "c3a8fbeb-b508-41d2-83f7-6a0ca152e234", <br> "testMachineResultId": 1434, <br> "testCaseResultId": 3857, <br> "testCaseId": 609, <br> "stepId": 2848, <br> "type": "NLP\_TEXT", <br> "action": "Click on Login or Sign Up Button", <br> "message": "Successfully performed click action.", <br> "errorCode": null, <br> "errorType": null, <br> "result": "SUCCESS", <br> "conditionalResult": null, <br> "visualTestResult": null, <br> "startTime": "2024-05-29T07:29:37Z", <br> "endTime": "2024-05-29T07:29:39Z", <br> "duration": 2040, <br> "visualEnabled": false }, <br> { "id": "36bbdc50-ca05-4289-8342-c9e20d0491a4", <br> "testMachineResultId": 1434, <br> "testCaseResultId": 3857, <br> "testCaseId": 609, <br> "stepId": 2849, <br> "type": "NLP\_TEXT", <br> "action": "Click on Login Button", <br> "message": "Successfully performed click action.", <br> "errorCode": null, <br> "errorType": null, <br> "result": "SUCCESS", <br> "conditionalResult": null, <br> "visualTestResult": null, <br> "startTime": "2024-05-29T07:29:42Z", <br> "endTime": "2024-05-29T07:29:44Z", <br> "duration": 1539, <br> "visualEnabled": false }, <br> { "id": "abefa297-cb14-48f4-b9e8-60db12854c03", <br> "testMachineResultId": 1434, <br> "testCaseResultId": 3857, <br> "testCaseId": 609, <br> "stepId": 2850, <br> "type": "NLP\_TEXT", <br> "action": "Select the radio button Mobile Number Radio Button", <br> "message": "Unable to perform click/check action on element, Element is not displayed.", <br> "errorCode": 1000001, <br> "errorType": "ASSERT\_ERROR", <br> "result": "FAILURE", <br> "conditionalResult": null, <br> "visualTestResult": null, <br> "startTime": "2024-05-29T07:29:47Z", <br> "endTime": "2024-05-29T07:29:51Z", <br> "duration": 3803, <br> "visualEnabled": false }, <br> { "id": "49b04ef4-40fa-476f-b2a7-17d7a6e68230", <br> "testMachineResultId": 1434, <br> "testCaseResultId": 3857, <br> "testCaseId": 609, <br> "stepId": 2851, <br> "type": "NLP\_TEXT", <br> "action": "Enter 9876543212 in the Mobile Number Radio Button field", <br> "message": "Major Test step failed .", <br> "errorCode": null, <br> "errorType": null, <br> "result": "NOT\_EXECUTED", <br> "conditionalResult": null, <br> "visualTestResult": null, <br> "startTime": "2024-05-29T07:29:54Z", <br> "endTime": "2024-05-29T07:29:54Z", <br> "duration": 1, <br> "visualEnabled": false }, <br> { "id": "0a2c386f-5639-4276-b69e-f8715cd7a85c", <br> "testMachineResultId": 1434, <br> "testCaseResultId": 3857, <br> "testCaseId": 609, <br> "stepId": 2852, <br> "type": "NLP\_TEXT", <br> "action": "Click on Continue Button", <br> "message": "Major Test step failed .", <br> "errorCode": null, <br> "errorType": null, <br> "result": "NOT\_EXECUTED", <br> "conditionalResult": null, <br> "visualTestResult": null, <br> "startTime": "2024-05-29T07:29:54Z", <br> "endTime": null, <br> "duration": 0, <br> "visualEnabled": false } <br> ], <br> "totalElements": null, <br> "totalPages": 1, <br> "pageable": null, <br> "last": false, <br> "numberOfElements": 6, <br> "first": true, <br> "sort": null, <br> "number": 0, <br> "size": 100, <br>  "empty": false, <br> } |
+
+In the response body above, we fetched the test step results of a test case with result ID 3857.
+
+**INDEX:**
+
+```
+URL: /api/v2/test_runs/{run_id}/test_case_results/{case_result_id}/step_results?query=<TS_QUERY>&page=<number>
+TYPE: GET
+TS_QUERY: <parameter><operator><value> chained with , (ex: query=result:PASSED)
+
+operator:
+
+: = EQUAL
+! = NOT EQUAL
+> = GRATER THAN
+< = LESS THAN
+~ = LIKE
+@ = IN
+; = NOT IN
+$ = CONTAINS
+
+STATUS: 200/401/500/400
+
+pagination: { page: <number>, pageSize: <number>, isLast: <boolean>, totalElements: <number> }
+
+```
+
+---

src/pages/docs/api/upload-and-update-test-data-profile.md

@@ -1,5 +1,5 @@
 ---
-title: "Upload and update test data profile"
+title: "Upload & Update Test Data Profile"
 page_title: "Upload/update test data profile via API in Testsigma"
 metadesc: "This article discusses in detail on REST API endpoints used for uploading the Apps and Attachments for test data profile in Testsigma Application."
 noindex: false