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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Qualio

Qualio Design Controls API

The Design Controls API from Qualio — 8 operation(s) for design controls.

Documentation Provider Profile APIs.io OpenAPI GitHub

Qualio Design Controls API is one of 11 APIs that Qualio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 18 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 0.1.

Requests are made against a single base URL, https://api.qualio.com.

18 operations 8 paths 13 schemas 3 GET8 OPTIONS4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1
Base URL
https://api.qualio.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qualio Design Controls API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (api_key). By default, every request must be authenticated.

Paths & Operations 18

Across 8 paths, the API surfaces 18 operations — 3 GET, 8 OPTIONS, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Design Controls 18
GET
/v1/design-controls/products
List products
listDesignControlProducts → 200403429
OPTIONS
/v1/design-controls/products
Lists the design control products in your Qualio instance. Design Controls (also called Product Development) is Qualio's module for medical-device design control and traceability: each product groups…
listDesignControlProductsOptions → 200
GET
/v1/design-controls/products/{productId}/test-cases
List test cases
listProductTestCases 1 param → 200400403404429
OPTIONS
/v1/design-controls/products/{productId}/test-cases
Lists the test cases for a design control product, identified by its UUID. A test case documents a verification procedure that proves one or more requirements are satisfied. Each item includes its id…
listProductTestCasesOptions 1 param → 200
POST
/v1/design-controls/products/{productId}/test-cases
Create a test case
createProductTestCase 1 param body → 201400403404409429
GET
/v1/design-controls/products/{productId}/requirements
List requirements
listProductRequirements 1 param → 200400403404429
OPTIONS
/v1/design-controls/products/{productId}/requirements
Lists the requirements for a design control product, identified by its UUID. A requirement describes a condition or capability the product must satisfy, organised into levels (req1–req4). Each item…
listProductRequirementsOptions 1 param → 200
POST
/v1/design-controls/products/{productId}/requirements
Create a requirement
createProductRequirement 1 param body → 201400403404409429
POST
/v1/design-controls/products/{productId}/test-results
Record a test result
createProductTestResult 1 param body → 200400403404429
OPTIONS
/v1/design-controls/products/{productId}/test-results
Records a test result against a test case in a design control product. A test result captures the outcome of executing a test case — passed, failed, or blocked — along with the execution date, wh…
createProductTestResultOptions 1 param → 200
PUT
/v1/design-controls/products/{productId}/test-cases/{testCaseId}
Update a test case
updateProductTestCase 2 params body → 200400403404429
OPTIONS
/v1/design-controls/products/{productId}/test-cases/{testCaseId}
Update an existing test case in a design control product. The request body replaces the mutable fields of the test case: title, type, and description. The type field must match the existing type of t…
updateProductTestCaseOptions 2 params → 200
PUT
/v1/design-controls/products/{productId}/requirements/{requirementId}
Update a requirement
updateProductRequirement 2 params body → 200400403404429
OPTIONS
/v1/design-controls/products/{productId}/requirements/{requirementId}
Update an existing requirement in a design control product. The request body replaces the mutable fields of the requirement: title, type, and description. The type field must match the existing type…
updateProductRequirementOptions 2 params → 200
POST
/v1/design-controls/products/{productId}/risks
Create a risk
createProductRisk 1 param body → 201400403404409429
OPTIONS
/v1/design-controls/products/{productId}/risks
Create a risk in a design control product. Set subType to iso for ISO 14971 qualitative risk analysis or fmea for Failure Mode and Effects Analysis. An optional id may be provided for idempotency; wh…
createProductRiskOptions 1 param → 200
PUT
/v1/design-controls/products/{productId}/risks/{riskId}
Update a risk
updateProductRisk 2 params body → 200400403404429
OPTIONS
/v1/design-controls/products/{productId}/risks/{riskId}
Update an existing risk in a design control product. The subType field must match the existing subType of the risk; changing the subType is not supported and returns 400. The request body replaces th…
updateProductRiskOptions 2 params → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are genericBadRequest400PathResponse (2 properties), genericBadRequest400ParametersResponse (2 properties), genericBadRequestResponse (2 properties), requirementConflictResponse (1 property). Each schema is shown below with its type and property counts.

riskConflictResponse
object
1 property 1 required
generic404
A generic response when a resource can't be found
genericForbiddenResponse
object
1 property 1 required
genericBadRequest400PathResponse
object
2 properties 2 required
dcProductId
string
A design control product id
riskId
string
The unique identifier of the risk to update. This is the id returned when the risk was created.
genericBadRequest400ParametersResponse
object
2 properties 2 required
throttledResponse
object
1 property 1 required
requirementId
string
The unique identifier of the requirement to update. This is the id returned when the requirement was created.
testCaseId
string
The unique identifier of the test case to update. This is the id returned when the test case was created.
genericBadRequestResponse
object
2 properties 2 required
testCaseConflictResponse
object
1 property 1 required
requirementConflictResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qualio-design-controls-api-openapi.yml Raw ↑

Other APIs Qualio publishes across the network.

Qualio Audit Trail API
AE Profile APIs.io
Qualio Change Management API
AE Profile APIs.io
Qualio Compliance Intelligence API
AE Profile APIs.io
Qualio Documents API
AE Profile APIs.io
Qualio Events API
AE Profile APIs.io
Qualio Resource Library API
AE Profile APIs.io
Qualio Suppliers API
AE Profile APIs.io
Qualio Tags API
AE Profile APIs.io
Qualio Training API
AE Profile APIs.io
Qualio User Management API
AE Profile APIs.io
#Design Controls
← Back to Q APIs
API Details
ID
qualio:qualio-design-controls-api
Base URL
https://api.qualio.com
Docs
https://developer-portal.qualio.com/
Provider
Qualio
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network