---
title: "Trigger Test Plan Execution from CI/CD / API"
slug: "trigger-test-plan-execution-from-cicd-api"
description: "In this feature video, learn how to trigger a test execution through an API."
tags: ["Automated Test Execution", "API Automation", "Get Started", "Test Modeller"]
updated: 2024-09-27T14:46:45Z
published: 2024-09-27T14:46:45Z
canonical: "knowledge.curiositysoftware.ie/trigger-test-plan-execution-from-cicd-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.curiositysoftware.ie/llms.txt
> Use this file to discover all available pages before exploring further.

# Trigger Test Plan Execution from CI/CD / API

In this feature video, learn how to trigger a test execution through an API.

[Embedded content](https://www.youtube.com/embed/kGIEC5PtEWE?&wmode=opaque&rel=0)

---

## Generate and Publish your Test Cases into a Test Plan

Inside a model, generate your test cases by navigating to **Scenarios**, clicking **Run**, and selecting the**Options**button next to **Automation Code**.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703375721.png)

Under the **Publish** tab, there is an option to publish the test cases into a **Test Plan**. In this example, we will be publishing our tests into a regression test plan.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703372116.png)

On the Modeller Homepage, navigate to **Tests** → **Test Plan** to view your test plans.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703368541.png)

After selecting a plan, you are taken to the **Test Suite** page. Here you can see the test cases that have been published to the plan, as well as their results. We can publish test cases from many different models in one single plan.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703364141.png)

---

## Execute Test Plan via an API Request

Under the **Actions** button, there is an option to **Embed in Pipeline**. This will show us the instructions to instrument the Test Suite execution via an API request.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703339008.png)![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703335476.png)

We can select the relevant API request and submit it through any tool that can submit API calls (in our example, we are using Postman).

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703319603.png)

We use the Job ID that was generated to query and track the status, as well as retrieve the results.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703315383.png)

---

## View Job Execution inside Quality Modeller

Back inside Quality Modeller, we can see that a new job has been created. This will trigger the creation and execution of the test cases that were part of the Test Plan.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703251232.png)![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1680703246801.png)

## Related

- [Automating Tests](/automating-and-executing-tests-in-test-modeller.md)
- [Quality Modeller 101](/test-modeller-101.md)
- [QuickStart API Automation](/quickstart-api-automation.md)