Leveraging QTest’s REST API for Automated Test Case Management

Problem: Manual test case handling slows CI pipelines

Team members open the QTest UI, locate a test case, copy its ID, and paste it into a script. This manual step adds latency and error risk, especially when dozens of cases must be prepared before each build.

Thesis: Use QTest’s REST API to automate test case lifecycle

The REST API lets you create, update, and query test cases programmatically, eliminating UI clicks and enabling seamless integration with CI/CD tools.

Core API capabilities

• Single‑case creation or update via POST /api/v1/test-cases or PUT /api/v1/test-cases/{id}
• Batch submission of multiple cases in one request, reducing round‑trips
• Filtered queries with pagination, allowing retrieval of subsets such as “open” or “high‑priority” cases

Authentication and rate limiting

Access is token‑based (OAuth2 bearer token or API key). Tokens have a limited lifetime; the server returns 401 when the token is expired, so your code must refresh the token before it expires. Rate limits are enforced per client ID; a 429 response indicates you have exceeded the quota. Check the response header X-RateLimit-Remaining to gauge how many calls you can still make, and implement exponential back‑off to stay within limits.

Worked example: creating a test case with curl

Run the following command in a terminal where you have a valid token.

curl -X POST "https://qtest.example.com/api/v1/test-cases" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '{
        "title": "Login flow verification",
        "description": "Test the happy path of user login",
        "priority": "high",
        "tags": ["smoke", "ui"]
      }'

The response includes a JSON object with an id field and a links array that points to related objects such as test runs. Store the id for later updates.

Batch request example

To create several cases at once, send an array in the request body:

curl -X POST "https://qtest.example.com/api/v1/test-cases/batch" \
  -H "Authorization: Bearer " \
  -H "Content-Type: application/json" \
  -d '[{"title":"API sanity check","priority":"medium","tags":["api"]},{"title":"Performance baseline","priority":"low","tags":["load"]}]'

Success returns a list of created case IDs.

Trade‑off: rate limits and versioning

QTest’s API enforces per‑client‑ID rate limits; exceeding the limit yields HTTP 429. Monitor the X-RateLimit-Remaining header and back off when the count drops near zero. Additionally, major version upgrades may introduce breaking changes, so pin your code to a specific version (e.g., v1) or implement migration logic.

Actionable closing: integrate now

Start with a minimal verification script:

1. Send GET /api/v1/test-cases?limit=1 and confirm the JSON structure matches the documented schema.
2. Inspect the X-RateLimit-Remaining header to ensure you stay within the quota.
3. Artificially shorten the token TTL and verify that a 401 is returned before the next request, confirming your refresh logic works.

Once the verification passes, add batch creation to your CI pipeline, and add error handling for 429 and 401 responses to keep automation reliable.