Execute Partial Test Plan Run via API

Performing a partial run in a test plan via an API call in Testsigma enables you to execute specific test suites and apply filters programmatically, providing flexibility and automation in your testing workflow. This documentation will guide you through configuring a partial test plan run, executing it via an API call, and scheduling the partial run for future execution.

Prerequisites

Before you begin, ensure that you have referred to:

1. Documentation on creating test plans.
2. Documentation on creating API key for authorization.
3. Documentation on getting test plan ID.

Configure Partial Test Plan Run

Follow these steps to configure a partial test plan run.

1. Open the Test Plan Details page for the Test Plan you want to configure a Partial Test Run for.
2. Click the dropdown next to the Run Now button and select Partial Run.
3. In the Partial Test Plan Run overlay, configure your settings as needed. This includes selecting the Test Suites to include or exclude, applying filters based on specific criteria, and making any other necessary adjustments.
4. Once you finalize the partial run configuration, click Save As Favorite.
5. Enter a name for your favorite, then click Save.

Partial Test Plan Run via API

Follow these steps to run the partial test plan via API call:

• Find the execution ID of your test plan in the Test Plan details and replace 3857 with it.
• Replace the name of the saved favorite configuration with fav_config_name.
• Replace config_id with the ID of the saved favorite configuration.

Fetch the Execution Config ID from the App

If you cannot use the GET API to retrieve the Execution Config ID, fetch it directly from the app using your browser's developer tools.

1. Open the test plan in Testsigma.
2. Right-click anywhere on the page and select Inspect.
3. Select the Network tab in the developer tools panel.
4. Select Preserve log.
5. Select Disable cache.
6. Clear existing log entries.
7. In the Network search bar, enter: method:POST
8. Select Run on the Partial Run configuration you want to trigger.
9. In the Network tab, open the POST request that appears.
10. Select the Payload tab.
11. Copy the id value from the payload.

Configure Schedule Partial Test Plan Run

Follow these steps to schedule a partial test run for future execution.

1. Open the Test Plan Details page for the Test Plan you want to configure a Schedule Partial Test Run for.
2. Hover over the schedule icon and select Schedule Partial Run.
3. In the Schedule Partial Test Run overlay, configure your settings as needed. This includes entering a name, selecting the time, date, and repeat frequency, choosing the Test Suites to include or exclude, and applying any necessary filters or adjustments.
4. Once you finalize the configuration, click Save As Favorite.
5. Enter a name for your favorite configuration, then click Save.

Schedule Partial Test Plan Run via API

Follow these steps to schedule a partial test run via API call.

Request Body Fields

• name: You can set the name of the scheduled test run.
• executionId: Replace 3857 with the execution ID of your test plan found in the Test Plan details.
• scheduleType: Defines the type of schedule. In this example, it is set to ONCE to indicate a one-time execution.
• status: Set the status of the scheduled test run to ACTIVE.
• nextInterval: Modify the time value in the schedule section to specify the desired time for the partial test run execution. Use the ISO 8601 format, such as YYYY-MM-DDTHH:MM:SSZ.
• executionConfig: Enter the details of the saved configuration in the executionConfig field. Replace fav_config_name with the name of the saved favorite configuration, and replace config_id with the ID of the saved favorite configuration.
• timezone: Specify the timezone for the scheduled execution.