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 plans API

Test plans - reusable selections of test cases.

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

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

This API exposes 5 operations across 2 paths, and defines 6 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.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 PATCH1 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 plans 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 5

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

plans 5

Test plans - reusable selections of test cases.

GET
/plan/{code}
Get all test plans
get-plans 3 params → 200401429
POST
/plan/{code}
Create a new test plan
create-plan 1 param body → 200401422429
GET
/plan/{code}/{id}
Get a specific test plan
get-plan 2 params → 200401404429
PATCH
/plan/{code}/{id}
Update a specific test plan
update-plan 2 params body → 200401404429
DELETE
/plan/{code}/{id}
Delete a specific test plan
delete-plan 2 params → 200401404429

Schemas 6

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

PlanListResponse
object
2 properties
IdResponse
object
2 properties
Plan
object
4 properties
PlanResponse
object
2 properties
PlanCreate
object
3 properties 2 required
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qase-plans-api-openapi.yml Raw ↑

Other APIs Qase publishes across the network.

Qase cases API
Qase defects API
Qase projects API
Qase results API
Qase runs API
Qase suites API