Starts test execution from a test spec and creates a new report (TestReport). TestReportResult entries are automatically generated for all test cases in the spec.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| specId | String | ✓ | Test spec composite ID ({projectId}.{specUuid}) |
| reportName | String | ✓ | Report name |
| webhookEnabled | Boolean | - | Enable webhook (defaults to the spec's setting) |
| author | String | - | Operator name |
Output: TestReport (without reportResults)
Returns the list of reports in the project associated with the access token.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| author | String | - | Operator name |
Output: TestReport[] (without reportResults)
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | String | ✓ | Test report composite ID ({projectId}.{specUuid}.{reportUuid}) |
| author | String | - | Operator name |
Output: TestReport (with reportResults field)
Updates a single test result.
Processing: When a queue is configured, processed asynchronously via SQS (equivalent to 202). For local development (no queue), processed synchronously (backwards compatible).
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| reportId | String | ✓ | Test report composite ID ({projectId}.{specUuid}.{reportUuid}) |
| resultId | String (UUID) | ✓ | Test result ID |
| testResult | String | - | OK / NG / SKIP |
| notes | String | - | Notes |
| executionResultLink | String | - | Link to execution result |
| author | String | - | Operator name |
Output (with queue):
{
"queued": true,
"messageId": "sqs-message-id-xxxx"
}Output (local development, no queue): TestReportResult
Synchronously updates multiple test results in bulk. Optimized for recording large numbers of test results from a CI/CD pipeline.
Constraint: Maximum 100 items per request
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| reportId | String | ✓ | Test report composite ID ({projectId}.{specUuid}.{reportUuid}) |
| items | Array | ✓ | Update list (1–100 items) |
| items[].resultId | String (UUID) | ✓ | Test result ID |
| items[].testResult | String | - | OK / NG / SKIP |
| items[].notes | String | - | Notes |
| items[].executionResultLink | String | - | Link to execution result |
| author | String | - | Operator name |
Output:
{
"reportId": "report-uuid",
"updated": 3
}Transitions the report to ABORTED status.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| reportId | String | ✓ | Test report composite ID ({projectId}.{specUuid}.{reportUuid}) |
| author | String | - | Operator name |
Output: TestReport (status: "ABORTED")
Transitions an ABORTED report back to IN_PROGRESS.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| reportId | String | ✓ | Test report composite ID ({projectId}.{specUuid}.{reportUuid}) |
| author | String | - | Operator name |
Output: TestReport (status: "IN_PROGRESS")
Force-transitions the report to COMPLETED status. Any incomplete results (testResult: null) are automatically set to SKIP.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| reportId | String | ✓ | Test report composite ID ({projectId}.{specUuid}.{reportUuid}) |
| author | String | - | Operator name |
Output:
{
"report": { },
"autoSkippedCount": 5
}The report field contains a TestReport object with status: "COMPLETED".
Returns the completion rate summary for all reports in the project associated with the access token.
Input:
| Parameter | Type | Required | Description |
|---|---|---|---|
| author | String | - | Operator name |
Output:
{
"totalReports": 10,
"notStartedReports": 1,
"inProgressReports": 3,
"completedReports": 5,
"abortedReports": 1,
"averageCompletionRate": 0.75
}