Skip to main content

​
Discover Modules / Suites / Test Cases

To execute tests by modules/suites/targets, you need the slugs (moduleSlug, suiteSlug, testCaseSlug). There are two ways to retrieve this information:

​
Option A: Get Complete Test Plan (Tree Structure)

Recommended approach. Returns the plan with the entire tree in data.modules[].suites[].cases[]. 
PLAN_ID="YOUR_PLAN_ID"
curl -sS -X GET "$API_URL/test-plans/$PLAN_ID" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Accept: application/json"

​
What to Extract from the Response

  • moduleSlug: data.modules[i].slug
  • suiteSlug: data.modules[i].suites[j].slug
  • testCaseSlug: data.modules[i].suites[j].cases[k].slug

​
Option B: List All Test Cases (Flattened)

Very useful for execution. Returns a flattened list with moduleSlug/moduleName, suiteSlug/suiteName, and slug/name of each case. 
PLAN_ID="YOUR_PLAN_ID"
curl -sS -X GET "$API_URL/test-plans/$PLAN_ID/cases" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Accept: application/json"

​
Using Slugs in Execution

Once you have the slugs, use them to execute specific portions of your test plan:
  • By modules: Use moduleSlugs array
  • By suites: Use suiteSlugs array
  • By specific cases: Use targets array with moduleSlug, suiteSlug, and testCaseSlug
See Execute Tests for details on execution modes.