Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qase results API

Test run results, including bulk publishing from CI/automation.

Qase results API is one of 7 APIs that Qase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include results. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 6 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.qase.io/v1.

6 operations 5 paths 8 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.qase.io/v1
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Qase results API declares 1 security scheme for authenticating requests. An API key is passed in the header as Token (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — A personal or application API token. Create it in the Qase app under Settings and pass it in the Token header on every request. All requests must use HTTPS.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

results 6

Test run results, including bulk publishing from CI/automation.

GET
/result/{code}
Get all test run results
get-results 6 params → 200401429
GET
/result/{code}/{hash}
Get a specific test run result
get-result 2 params → 200401404429
POST
/result/{code}/{id}
Create a test run result
create-result 2 params body → 200401422429
POST
/result/{code}/{id}/bulk
Bulk create test run results
create-result-bulk 2 params body → 200401422429
PATCH
/result/{code}/{id}/{hash}
Update a test run result
update-result 3 params body → 200401404429
DELETE
/result/{code}/{id}/{hash}
Delete a test run result
delete-result 3 params → 200401404429

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ResultCreate (6 properties), Result (6 properties), Error (3 properties), ResultResponse (2 properties). Each schema is shown below with its type and property counts.

HashResponse
object
2 properties
ResultBulkCreate
object
1 property 1 required
ResultCreate
object
6 properties 2 required
ResultResponse
object
2 properties
ResultListResponse
object
2 properties
Result
object
6 properties
BaseResponse
object
1 property
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qase-results-api-openapi.yml Raw ↑

Other APIs Qase publishes across the network.

Qase cases API
Qase defects API
Qase plans API
Qase projects API
Qase runs API
Qase suites API