Skip to content

Commit 82ea92d

Browse files
Updated fetching ids in reports via api doc (#1084)
* updated fetching ids in reports via api doc * Update export-test-reports.md
1 parent 208739a commit 82ea92d

7 files changed

Lines changed: 56 additions & 6 deletions

File tree

‎src/pages/docs/api/export-test-reports.md‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ contextual_links:
1818
- type: link
1919
name: "Report Generation Flow"
2020
url: "#report-generation-flow"
21+
- type: link
22+
name: "Retrieve the Result IDs"
23+
url: "#retrieve-the-result-ids"
2124
- type: link
2225
name: "API Specification"
2326
url: "#api-specification"
@@ -46,7 +49,7 @@ Testsigma allows you to export test reports in XML, PDF, or Excel format at any
4649
> Before you begin, ensure that:
4750
> 1. An API key exists for your Testsigma account. Refer to the [documentation on generating API keys](https://testsigma.com/docs/configuration/api-keys/).
4851
> 2. The test plan run is complete.
49-
> 3. The result ID for the level you want to export is available. Refer to the [documentation on fetching test results at all levels](https://testsigma.com/docs/api/test-results-at-all-levels/).
52+
> 3. The result ID for the level you want to export is available. Refer to [Retrieve the Result IDs](#retrieve-the-result-ids) for test machine and test suite exports, or to the [documentation on fetching test results at all levels](https://testsigma.com/docs/api/test-results-at-all-levels/).
5053
> 4. PDF report export is enabled for your account, if you export in PDF format.
5154
5255
---
@@ -81,6 +84,46 @@ Report generation is asynchronous. The same endpoint both triggers the report an
8184

8285
---
8386

87+
## **Retrieve the Result IDs**
88+
89+
The test machine and test suite result IDs are not exposed in the UI. Retrieve them from the network requests that the **Run Results** page sends, then use them in the export endpoint for that level.
90+
91+
[[info | NOTE:]]
92+
| The test plan run ID is available in the URL of the **Run Results** page. Refer to the [documentation on obtaining the run ID](https://testsigma.com/docs/api/test-plans/#obtaining-the-run-id).
93+
94+
### **Retrieve the Test Machine Result ID**
95+
96+
1. Open the completed test plan run on the **Run Results** page.
97+
2. From the view dropdown, select **Test Machines**.
98+
3. Select the test machine you want to export.
99+
4. Open the browser developer tools and go to the **Network** tab.
100+
5. Clear the network log.
101+
6. Reload the page.
102+
7. Select the **Environments** request in the network log.
103+
8. In the **Preview** panel, copy the machine result ID from the response.
104+
![Machine ID](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/machine_id_fetch.png)
105+
106+
9. Use the copied value as **{MACHINE\_RESULT\_ID}** in the export request.
107+
108+
### **Retrieve the Test Suite Result ID**
109+
110+
1. Open the completed test plan run on the **Run Results** page.
111+
2. From the view dropdown, select **Test Suites**.
112+
3. Select the test suite you want to export.
113+
4. Open the browser developer tools and go to the **Network** tab.
114+
5. Clear the network log.
115+
6. Reload the page.
116+
7. Select the **Test Suite** request in the network log.
117+
8. In the **Preview** panel, copy the test suite result ID from the response.
118+
![Suite ID](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/fetch_suite_id.png)
119+
120+
9. Use the copied value as **{SUITE\_RESULT\_ID}** in the export request.
121+
122+
[[info | NOTE:]]
123+
| The test case result ID follows the same pattern at the test case level. Refer to the [documentation on fetching test results at all levels](https://testsigma.com/docs/api/test-results-at-all-levels/) for the response fields at each level.
124+
125+
---
126+
84127
## **API Specification**
85128

86129
### **Export a Test Plan Run Report**

‎src/pages/docs/atto/generative-ai/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Testsigma also integrates seamlessly with tools like Jira, Figma, Xray, and qTes
4141
>
4242
> 1. From the **Dashboard**, go to **Settings > Preferences**.
4343
> 2. Turn on the **Generative AI features** toggle.
44-
![GenAI Features](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/GenAI_Toggle_in_Preferences.png)
44+
![GenAI Features](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Gen_AI_Preferences_Updated.png)
4545

4646
[[info | **NOTE**:]]
4747
|

‎src/pages/docs/auto-healing/enable-the-auto-healing-feature.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ This article discusses how to enable the auto-healing feature.
2929
1. Navigate to **Settings > Preferences**.
3030
![Preferences](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/auto_heal_1.png)
3131

32-
2. On the **Preferences** page, enable the toggle on the **Auto Healing** widget.
33-
![Auto-healing](https://s3.amazonaws.com/website-static-docs.testsigma.com/new_images/projects/Updated_Doc_Images/auto_heal_2.png)
32+
2. On the **Preferences** page, enable the toggle on the **Generative AI Autoheal** widget.
33+
![Auto-healing](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/AI_Auto_healing_toggle.png)
3434

3535
Your tests are ready to execute without manual intervention whenever there are changes in the build. The Auto Healing feature will automatically correct the elements.
3636

‎src/pages/docs/desktop-automation/batch-elements.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Capture every UI element in a desktop application window at once using the **Bat
4444
1. From the left navigation bar, go to **Create Tests > Elements**.
4545

4646
2. On the Elements list page, click **Record**.
47-
47+
![Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Desktop_Elements.png)
4848
3. In the **Select application** window, select the desktop application you want to record against.
4949

5050
[[info | **NOTE**:]]
@@ -53,6 +53,7 @@ Capture every UI element in a desktop application window at once using the **Bat
5353
4. Click **Start recording**.
5454

5555
5. In the Element Recorder, click the **Batch** tab. The recorder captures every element in the currently open window of the application and lists them in a hierarchical tree.
56+
![Batch Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Desktop_Batch_Elements.png)
5657

5758
[[info | **NOTE**:]]
5859
| When you switch windows within the same application, the recorder captures elements from the new window and clears those recorded from the previous one.

‎src/pages/docs/desktop-automation/selective-elements.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,15 @@ Capture UI elements one at a time in a desktop application using the **Selective
4444
1. From the left navigation bar, go to **Create Tests > Elements**.
4545

4646
2. On the Elements list page, click **Record**.
47+
![Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Desktop_Elements.png)
4748

4849
3. In the **Select application** window, select the desktop application you want to record against.
4950

5051
[[info | **NOTE**:]]
5152
| Only applications running on your device are listed. Use the search field to filter the list, or click the refresh icon to reload it after opening a new application.
5253

5354
4. Click **Start recording**. The Element Recorder opens on the **Selective** tab, with the application name displayed in the recorder header.
55+
![Selective Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Desktop_Selective_Elements.png)
5456

5557
5. Hover over an element in the application until it is highlighted in green, then click it to capture it.
5658

‎src/pages/docs/desktop-automation/test-cases-for-desktop-automation.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,15 @@ Create test cases for a desktop application by recording your interactions or by
4848
3. On the test case details page, click **Record** in the **Action Panel**.
4949

5050
4. In the **Select application** window, select the desktop application you want to record against.
51+
![Select App](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Recorder_Desktop.png)
5152

5253
[[info | **NOTE**:]]
5354
| Only applications running on your device are listed. Use the search field to filter the list, or click the refresh icon to reload it after opening a new application.
5455

5556
5. Click **Start recording**. The Testsigma Recorder opens, the selected application comes to the foreground, and **Open application** is added as the first test step with the application path.
5657

5758
6. Perform actions in the application. Each interaction is captured as a test step, and the elements involved are created automatically.
59+
![Desktop Interactions](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Desktop_Interactions.png)
5860

5961
[[info | **NOTE**:]]
6062
| To record an advanced action on an element, press **Ctrl** and click the element.
@@ -89,6 +91,8 @@ To add a step manually, click **Actions** from the drop-down on the test case de
8991

9092
6. Click **Resume** to continue the run.
9193

94+
![Desktop Copilot Execution](https://s3.amazonaws.com/static-docs.testsigma.com/new/projects/applications/Desktop_Copilot.png)
95+
9296
### **Execution Controls**
9397

9498
**Resume** continues the test from the next execution step without restarting from the beginning. **Rec** records additional steps into the test case during the session.

‎src/pages/docs/projects/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ The engines available depend on the application type:
7878
| Android | Classic |
7979
| iOS | Classic |
8080
| Mobile Web | Classic |
81-
| Salesforce | Classic |
81+
| Salesforce | Classic and Modern |
8282
| REST API | Classic |
8383
| Desktop | Classic |
8484
| Windows | Classic |

0 commit comments

Comments
 (0)