What endpoints do they use?
Phase 1: Before Test Execution (Initialization)
-
Configuration Management (if configurations specified)
- GET
https://api.qase.io/v1/configuration/{code}
(v1) - POST
https://api.qase.io/v1/configuration/{code}
(v1) - POST
https://api.qase.io/v1/configuration/{code}/group
(v1) - Retrieves existing configurations and creates new ones if
createIfNotExists
is enabled.
- GET
-
Environment Retrieval (if environment specified)
- GET
https://api.qase.io/v1/environment/{code}
(v1) - Fetches environment details to obtain environment ID for the test run
- Executed after configuration management, before run creation
- GET
-
Run Creation
- POST
https://api.qase.io/v1/run/{code}
(v1) - Creates new test run with retrieved environment and configuration IDs
- Stores run ID for subsequent operations
- Called by framework reporter's
onBegin()
hook
- POST
Phase 2: During Test Execution (Real-time Processing)
-
Attachment Upload (per test result with attachments)
- POST
https://api.qase.io/v1/attachment/{code}
(v1) - Uploads screenshots, logs, and other test artifacts
- Returns attachment hashes for referencing in results
- Executed during result transformation before results upload
- POST
-
Results Upload (batched)
- POST
https://api.qase.io/v2/{project_code}/run/{run_id}/results
(v2) - Uploads test results in configurable batches (default: 200 results)
- Triggered immediately when batch threshold is reached
- Provides real-time feedback and dashboard links for failed tests
- Called by framework reporter's
onTestEnd()
hook viaaddTestResult()
- POST
Phase 3: After Test Execution (Finalization)
-
Final Results Upload (remaining results)
- POST
https://api.qase.io/v2/{project_code}/run/{run_id}/results
(v2) - Uploads any remaining results that didn't reach batch threshold
- POST
-
Run Completion (if enabled)
- POST
https://api.qase.io/v1/run/{code}/{id}/complete
(v1) - Marks test run as completed and generates run URL
- Called by framework reporter's
onEnd()
hook viapublish()
- POST
Framework Integration Points
Hook | Action | API Calls Triggered |
---|---|---|
onBegin() | startTestRun() | Configuration → Environment → Run Creation |
onTestEnd() | addTestResult() | Attachment Upload → Results Upload (batched) |
onEnd() | publish() | Final Results Upload → Run Completion |
Updated 6 days ago